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/
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 details)
Built Distribution
File details
Details for the file sphinx-hoverxref-0.1b1.tar.gz.
File metadata
- Download URL: sphinx-hoverxref-0.1b1.tar.gz
- Upload date:
- Size: 19.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56e740f9729814bfebc555b0fef7ac30914ba317518e57c45e6209ad88ff3ecc |
|
| MD5 | 6528533bef32bd003295337cfe3fb469 |
|
| BLAKE2b-256 | 96845b2b4936c875a7f10ca6e37c88d67c83755d1245af99076dcc8edd6ccc3e |
Provenance
File details
Details for the file sphinx_hoverxref-0.1b1-py3-none-any.whl.
File metadata
- Download URL: sphinx_hoverxref-0.1b1-py3-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e7b54ef90c676c4aa930403cc218b0f870e2789a0205fbf32cda64ef16638222 |
|
| MD5 | 01ee094d5234d8d09a97a8405c53a38b |
|
| BLAKE2b-256 | 08ccb086e9d3b303011fd6423f3b33401aa4e13adddf142f498d350292113229 |
