sphinx-hoverxref is a Sphinx extension to add tooltips on the cross references of the documentation with the content of the linked section.
Warning
This extension is currently in Beta state. This means that there may be some things not well supported or unexpected behavior. If you find any issue, please report it in the issue tracker.
You can install sphinx-hoverxref from PyPI:
pip install sphinx-hoverxref
Or, alternatively, install it from GitHub directly (requires git):
pip install git+https://github.com/readthedocs/sphinx-hoverxref@master
Add this extension in your conf.py file as:
extensions = [
# ... other extensions here
'hoverxref.extension',
]Check out the full documentation at https://sphinx-hoverxref.readthedocs.io/