Sphinx extension to show tooltips with content embedded when hover a reference.
Project Links
Meta
Author: Manuel Kaufmann
Classifiers
Development Status
- 5 - Production/Stable
Framework
- Sphinx
- Sphinx :: Extension
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python :: 2.7
- Python :: 3
Topic
- Documentation :: Sphinx
- Software Development :: Documentation
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
You can install sphinx-hoverxref from PyPI:
pip install sphinx-hoverxref
Or, alternatively, install it from GitHub directly (requires git):
pip install git+https://github.com/readthedocs/sphinx-hoverxref
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/
1.4.2
Nov 18, 2024
1.4.1
Sep 09, 2024
1.4.0
May 30, 2024
1.3.0
Oct 25, 2022
1.2.0
Oct 24, 2022
1.1.3
Jul 13, 2022
1.1.2
Jul 07, 2022
1.1.1
Jun 07, 2022
1.1.0
Jun 01, 2022
1.0.1
Jan 18, 2022
1.0.0
Dec 01, 2021
0.9b1
Nov 23, 2021
0.8b1
Oct 19, 2021
0.7b1
Jul 12, 2021
0.6b1
Jun 07, 2021
0.5b1
Jun 30, 2020
0.4b1
May 26, 2020
0.3b1
Apr 17, 2020
0.2b1
Apr 10, 2020
0.1b1
Aug 21, 2019
