Skip to main content

Sphinx extension to show tooltips with content embedded when hover a reference.

Project description

Build status Current PyPI version Documentation status Repository license


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




You can install sphinx-hoverxref from PyPI:

pip install sphinx-hoverxref

Or, alternatively, install it from GitHub directly (requires git):

pip install git+


Add this extension in your file as:

extensions = [
 # ... other extensions here



Check out the full documentation at

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-hoverxref-1.1.1.tar.gz (114.0 kB view hashes)

Uploaded source

Built Distribution

sphinx_hoverxref-1.1.1-py2.py3-none-any.whl (31.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page