Skip to main content

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/

Release files for sphinx-hoverxref 1.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-hoverxref 1.4.2
File Size Uploaded
sphinx_hoverxref-1.4.2.tar.gz 1.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-hoverxref 1.4.2
File Interpreter ABI Platform
sphinx_hoverxref-1.4.2-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 1.7 MB

Release files / sphinx_hoverxref-1.4.2.tar.gz

Download URL sphinx_hoverxref-1.4.2.tar.gz
Size 1.7 MB
Tags Source
SHA-256 checksum
How to use checksums
74fab961b1b8c0e9c2cf22fa195c0e783d635e78686d39dd06ff157c196ca0c9
BLAKE2b-256 checksum
How to use checksums
d66d89764d3c719ed172d94778a74661cca647b2475165ae6cde1f73c9524d63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

Release files / sphinx_hoverxref-1.4.2-py2.py3-none-any.whl

Download URL sphinx_hoverxref-1.4.2-py2.py3-none-any.whl
Size 32.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
4fc2e283e908d9df61ea9196589934944a7e2e6e3cb753a420b938cd6d14e220
BLAKE2b-256 checksum
How to use checksums
193bd981175d7b9bbbcf6894faf640d15198394efc7dedd6182332c4a791a5a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page