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.

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.

Source Distribution

sphinx-hoverxref-0.3b1.tar.gz (29.7 kB view hashes)

Uploaded Source

Built Distribution

sphinx_hoverxref-0.3b1-py3-none-any.whl (34.2 kB view hashes)

Uploaded Python 3

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