-
-
Notifications
You must be signed in to change notification settings - Fork 577
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
Add floating window tooltips for cross-references in the docs #3083
Add floating window tooltips for cross-references in the docs #3083
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## develop #3083 +/- ##
========================================
Coverage 99.71% 99.71%
========================================
Files 248 248
Lines 18749 18749
========================================
Hits 18695 18695
Misses 54 54 ☔ View full report in Codecov by Sentry. |
This should fix the appearance of the tooltips on the light theme. Increases the max width to 750 pixels and adds animations too
It turns out that dark mode support is not available yet: readthedocs/sphinx-hoverxref#231, which means either one of the light or dark themes breaks: the Footnotes
|
Can you look into the suggested solution with css? |
using the pydata theme colours
0509019
to
1a972bd
Compare
It should look fine now on both light and dark themes. The unit tests are failing because |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks amazing, thanks @agriyakhetarpal!
Also, we are currently redirecting users to scipy's user guide - the text available under API documentation. Caught this using the tooltip haha! Maybe that can be fixed in this PR.
instead of the SciPy user guide
Good catch, thanks! Fixed it, though this is very strange and should not happen – I can file a bug report in the |
Description
This PR adds and configures support for sphinx-hoverxref, which enables hovering over classes, methods, and other links to directly display their results within the same page
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Key checklist:
$ pre-commit run
(see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)$ python run-tests.py --all
$ python run-tests.py --doctest
You can run unit and doctests together at once, using
$ python run-tests.py --quick
.Further checks: