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/humitos/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.1b1.tar.gz
(19.5 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_hoverxref-0.1b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7b54ef90c676c4aa930403cc218b0f870e2789a0205fbf32cda64ef16638222 |
|
MD5 | 01ee094d5234d8d09a97a8405c53a38b |
|
BLAKE2b-256 | 08ccb086e9d3b303011fd6423f3b33401aa4e13adddf142f498d350292113229 |