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
Built Distribution
File details
Details for the file sphinx_hoverxref-1.4.1.tar.gz.
File metadata
- Download URL: sphinx_hoverxref-1.4.1.tar.gz
- Upload date:
- Size: 1.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.32.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b5e302ff5ca953ca3f271d9b9f09d92f59158335dfa8e9cfac415d1686a3f27b |
|
| MD5 | 67e1a0c06dde25ca80e16449ab5d9ff5 |
|
| BLAKE2b-256 | 2714840bf471adb0322ca36b1f577bd966871ae5e88490ac53f741966dadba52 |
Provenance
File details
Details for the file sphinx_hoverxref-1.4.1-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_hoverxref-1.4.1-py2.py3-none-any.whl
- Upload date:
- Size: 32.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.32.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | be4c8afecf4d6f9b1ecccafd7be736fd8a761c9ab2db36140ca1ee40196916a8 |
|
| MD5 | 9be8b304d5316b8db7b31af7905815bf |
|
| BLAKE2b-256 | 5c43e10f3e959295464946d409620babc68b35459807ab8e906ae254252b9e1f |
