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/
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-0.4b1.tar.gz
(30.0 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-0.4b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ab5b41d5a741d8222d1b651179b8ba543dde920cc0415e0a4de9bf8a362b5e9 |
|
MD5 | 405ece40ecd2294d0b141633dbd9af1e |
|
BLAKE2b-256 | f9722bc3f2b9c8b97b9effd5b5cde7dcec5f1f9ee1dfb08e62767ebacf6b3b1a |