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.6b1.tar.gz
(31.1 kB
view details)
Built Distribution
File details
Details for the file sphinx-hoverxref-0.6b1.tar.gz.
File metadata
- Download URL: sphinx-hoverxref-0.6b1.tar.gz
- Upload date:
- Size: 31.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4dd3e1d3a4e81073dc2301b2312eaa57b68a936b18f2476fee47c43e52219dce |
|
| MD5 | d55356c24fe464b1e0767493dfaaed5d |
|
| BLAKE2b-256 | 527c6ca7f7dc1b7983011d776bda3eea2872eaa1cecc909674aef8e947e0b85c |
File details
Details for the file sphinx_hoverxref-0.6b1-py3-none-any.whl.
File metadata
- Download URL: sphinx_hoverxref-0.6b1-py3-none-any.whl
- Upload date:
- Size: 36.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6b73dd8d1c7bef4107125d36956790671f36f8343805b8db25e1fc278a86111b |
|
| MD5 | 02204921ffad1db5c1af8d6331c67e25 |
|
| BLAKE2b-256 | 85e44fbe5bcb4ff06bcd1dada4f376bb25f85e11d444d8c8827214c7d58739fa |
