Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend hoverxref_roles #4495

Closed
Gallaecio opened this issue Apr 15, 2020 · 3 comments · Fixed by #4563
Closed

Extend hoverxref_roles #4495

Gallaecio opened this issue Apr 15, 2020 · 3 comments · Fixed by #4563
Labels
docs enhancement good first issue

Comments

@Gallaecio
Copy link
Member

@humitos suggested extending the hoverxref_roles setting of the corresponding Sphinx extension so that the display-on-hover behavior of the documentations works for things like signal or setting references.
@Gallaecio Gallaecio mentioned this issue Apr 15, 2020
Merged
@vinaykonuru
Copy link

I'd like to give this a shot.

@willbeaufoy
Copy link
Contributor

@redrolor are you still working on this? If not I can take it.

willbeaufoy added a commit to willbeaufoy/scrapy that referenced this issue May 10, 2020
@willbeaufoy
Extend hoverxref_roles to custom crossrefs (scrapy#4495)
e3357aa 
Additionally, I think the documentation in docs/README.rst is out
of date: none of the commands built the docs properly for me (I had to
revert the changes in 901892d to docs/conf.py to get them to build
properly, and even then no tooltips displayed).

It seems that scrapy is now using tox to build the docs, so I have
replaced the commands with the tox one that worked for me.
@willbeaufoy
Copy link
Contributor

As @redrolor didn't reply I have sent a pull request for this.

@willbeaufoy willbeaufoy mentioned this issue May 10, 2020
Merged
willbeaufoy added a commit to willbeaufoy/scrapy that referenced this issue May 10, 2020
@willbeaufoy
Extend hoverxref_roles to custom crossrefs (scrapy#4495)
1bfbcc6
Gallaecio added a commit that referenced this issue Jun 1, 2020
@Gallaecio
Merge pull request #4563 from willbeaufoy/hoverxref
c86a103 
Extend hoverxref_roles to custom crossrefs (#4495)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs enhancement good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Extend hoverxref_roles to custom crossrefs (#4495) willbeaufoy/scrapy
3 participants
@willbeaufoy @Gallaecio @vinaykonuru