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/
Project details
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.2.tar.gz
(114.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-1.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 696692ce9eb0f0f191b683712cf0c0443bd7770197754e26e90348397c1c5478 |
|
MD5 | c0c17f52d72dc593eb360ef5b4a4ab34 |
|
BLAKE2b-256 | 5ba8888eae58288d89a84f21c1c4e57d2eb99b33014841941f501d6831b1a54e |