Skip to main content

Sphinx extension to embed content in a tooltip on xref hover

Project description

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/

Project details


Download files

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

Files for sphinx-hoverxref, version 0.7b1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_hoverxref-0.7b1-py3-none-any.whl (36.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinx-hoverxref-0.7b1.tar.gz (31.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page