Welcome to sphinx-hoverxref!

sphinx-hoverxref is a Sphinx extension to add tooltips on the cross references of the documentation with the content of the linked section.

Online documentation:
https://sphinx-hoverxref.readthedocs.io/
Source code repository (and issue tracker):
https://github.com/readthedocs/sphinx-hoverxref/
Badges:
Build status Current PyPI version Documentation status Repository license

Usage

To show a tooltip on a reference, use the role hoverxref to link to any document or section.

Writing this reStructuredText:

This will :hoverxref:`show a tooltip <hoverxref:hoverxref>` in the linked words.

will render to:

This will show a tooltip in the linked words.

Tip

This new hoverxref role is an alias of the ref role and works in the same.

API Reference