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-0.9b1.tar.gz
(27.8 kB
view details)
Built Distribution
File details
Details for the file sphinx-hoverxref-0.9b1.tar.gz.
File metadata
- Download URL: sphinx-hoverxref-0.9b1.tar.gz
- Upload date:
- Size: 27.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7741645323be4f9d8c6a35878946dd433bc081b8ed359c08fc3fa589c594831a |
|
| MD5 | 010f970154c0dce5d518302394ba6e7e |
|
| BLAKE2b-256 | c1c8b825558e58888c539b478cc21c257c26c44f25b6902bef9d68a52aa64841 |
File details
Details for the file sphinx_hoverxref-0.9b1-py3-none-any.whl.
File metadata
- Download URL: sphinx_hoverxref-0.9b1-py3-none-any.whl
- Upload date:
- Size: 31.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2e13bf776a044ecabfb32632f5c6cb72677fceeb67bafc498e3f4985dd5fb810 |
|
| MD5 | f931b43367ab97ff19e43330bb9e5060 |
|
| BLAKE2b-256 | 2faf9c4ce07d5e6ed895162a82b3190e70012cefd8c752e89945a0ba204733c1 |
