8000 GitHub - readthedocs/sphinx-hoverxref at e2c3d6421af441447f9b6fb2dd802a1ff1af244b
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

readthedocs/sphinx-hoverxref

Repository files navigation

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.

Example

docs/sphinx-hoverxref-example.png

Installation

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

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/

Contributors 16

0