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/
Project details
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.2.0.tar.gz
(1.7 MB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b683a4c9020c8b3172467236e6af3b7a7923a91dc9dde79370d6f8e06dac3310 |
|
MD5 | ed6de875e0f1752609fed1ac10e7dff4 |
|
BLAKE2b-256 | 5217163b0f80ff9d18e4349e7b8169002947de34238fef772e3a17050e884f50 |