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@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.1.0.tar.gz
(113.8 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-1.1.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 163f10a7b579c0da535d935536c35f54870e14376c06dff8d28c12b0de2db2e6 |
|
| MD5 | 1db7ee934e1e3eab1970264ac149952f |
|
| BLAKE2b-256 | 63a1f42058e329cde6a5f1c4f4a6afb5c1b7201c1a93d5c883003b98511f1046 |
