Sphinx extension to show tooltips with content embedded when hover a reference.
Project description
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
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 history Release notifications | RSS feed
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.3.0.tar.gz
(1.7 MB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-1.3.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1064e4b1da49422873de555d79dc544da1556820fee05ab56f39d36cc86ba6ad |
|
| MD5 | ae007aeb383dbb069c29b390c2b46bcc |
|
| BLAKE2b-256 | ecfa1b860e4662906c7f7276a84d361b4ecdb2404adb39610b1673f82cf51b03 |
