Extend hoverxref_roles to custom crossrefs (#4495) #4563
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #4563 +/- ##
==========================================
+ Coverage 84.53% 84.93% +0.39%
==========================================
Files 164 164
Lines 9908 10188 +280
Branches 1475 1550 +75
==========================================
+ Hits 8376 8653 +277
- Misses 1266 1270 +4
+ Partials 266 265 -1
|
Gallaecio
approved these changes
May 11, 2020
Works like a charm!
You can test it locally by editing tox.ini to point to my copy of @willbeaufoy’s branch deployed at https://scrapy-gallaecio.readthedocs.io/en/hoverxref/
setenv =
READTHEDOCS_PROJECT=scrapy-gallaecio
READTHEDOCS_VERSION=hoverxref
elacuesta
reviewed
May 12, 2020
elacuesta
reviewed
May 25, 2020
None of the existing 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). Building them with tox worked for me, but other developers say they can still use the original method, so the docs now contain both.
elacuesta
approved these changes
May 27, 2020
Looks good. Latest build error is completely unrelated, looks like a Travis glitch, safe to ignore IMHO.
Thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
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).
Building them with tox worked for me, but other developers say they
can still use the original method, so the docs now contain both.
Fixes #4495.