Sphinx extension to embed content in a tooltip on xref hover
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
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/
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.0.0.tar.gz
(27.8 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-1.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a8a052dfd755efd47d24acf7a8e0271c8781f3d990628d85758ea1ee0e83bc9e |
|
| MD5 | 9a49c20b6050716664ff0758ffc1024f |
|
| BLAKE2b-256 | 11fb9ea05b5176fa1bccd4905b3d6c81f1a716bf358dd0f01fd54ae500133de6 |
