Use sphinx-hoverxref extension to show tooltips in our docs
#6080
Conversation
| ] | ||
| templates_path = ['_templates'] | ||
|
|
||
| hoverxref_auto_ref = True | ||
| # hardcode version because external versions does not work properly |
There was a problem hiding this comment.
Why don't they work properly?
There was a problem hiding this comment.
Because the version slug is the number of the PR. In this case, 6080.
So, the URL https://readthedocs.org/api/v2/embed/?project=docs&version=6080&doc=config-file/v2§ion=Migrating%20from%20v1 returns a 404
but using latest works.
I didn't check the backend yet to know if this can be fixed.
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
|
This makes the extension works on our docs.
Although, there is still a bug that makes relative links inside the tooltip content to break: #6082 I'm closing this PR for now. We can enable the extension once we have that other issue fixed. |
Example of how our docs will look like with the
sphinx-hoverxrefextension installed and applied to all:ref:roles.Result can be seen at https://external-builds.readthedocs.io/html/docs/6080/index.html