Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.65 KB

README.rst

File metadata and controls

63 lines (39 loc) · 1.65 KB

Build status Current PyPI version Documentation status Repository license

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.

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.

Example

docs/sphinx-hoverxref-example.png

Installation

pip install git+https://github.com/readthedocs/sphinx-hoverxref@master

Configuration

Add this extension in your conf.py file as:

extensions = [
 # ... other extensions here

 'hoverxref.extension',
]

Documentation

Check out the full documentation at https://sphinx-hoverxref.readthedocs.io/