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.3b1.tar.gz
(29.7 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-0.3b1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7d9b92b6d0481552181f67a30f481f5204cb4e70fbc9ad002fb6c0a8c6b11bf8 |
|
| MD5 | 0d3d0571d689304a5c896f093e23f1fd |
|
| BLAKE2b-256 | bbe0e7981641bc5184d37a500b34aa6555193ab84f750cd23d2218f375dae2e8 |
