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.7b1.tar.gz
(31.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-0.7b1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c32b8c2e3fc34d194a62a1b473482e07f6244af6df9a7cb97b2fd5ad21a37986 |
|
| MD5 | 4d6e815420d6885ef459e17054ce4f20 |
|
| BLAKE2b-256 | 231718c97a33011d0b164a2172db42d1eec5a2aad0303e047dc15f749f6809ec |
