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.8b1.tar.gz
(27.3 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-0.8b1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 555a51a37e1e169912f0dc9c488352cf6a57aa220d07b9fdcc0f6670ea27b7dd |
|
| MD5 | d3c0682c2c20fbd754c9291262d1e587 |
|
| BLAKE2b-256 | 4c7c8702fad4ef93a9d15c0a734a6ef9073a7bf0cb9c2792f4a95120e9d94be2 |
