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.1.1.tar.gz
(114.0 kB
view details)
Built Distribution
File details
Details for the file sphinx-hoverxref-1.1.1.tar.gz.
File metadata
- Download URL: sphinx-hoverxref-1.1.1.tar.gz
- Upload date:
- Size: 114.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.27.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1eca678f7df62dcc1ce1e3aae1480813dbe40e28de581213e959bb85ffd9f6d3 |
|
| MD5 | f719b64a5642f955fd65235cd3dec22c |
|
| BLAKE2b-256 | d36b4ab45d32473e37a062c33b241281700b4036a3234fecde3c888a32ac1a36 |
Provenance
File details
Details for the file sphinx_hoverxref-1.1.1-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_hoverxref-1.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 31.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.27.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 327097089b72900053bb0a5e00831c86d4ba312bb338b1d38d2e170b68b877c7 |
|
| MD5 | 97cd37fc44aeb8acd999b5dd48ba7892 |
|
| BLAKE2b-256 | ddb3b6a11641f2c5e8738138aeffdcfa163756acd3e4cecec425a68cc2f1a328 |
