Sphinx extension to show tooltips with content embedded when hover a reference.
|PyPI version| |Docs badge| |License|
sphinx-hoverxref is a Sphinx_ extension to add tooltips on the cross references of the documentation with the content of the linked section.
.. image:: docs/sphinx-hoverxref-example.png
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
Add this extension in your conf.py file as:
.. code-block:: python
extensions = [ # ... other extensions here
'hoverxref.extension',
]
Check out the full documentation at https://sphinx-hoverxref.readthedocs.io/
.. _Sphinx: https://www.sphinx-doc.org/
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-hoverxref.svg :target: https://pypi.org/project/sphinx-hoverxref :alt: Current PyPI version .. |Docs badge| image:: https://readthedocs.org/projects/sphinx-hoverxref/badge/?version=latest :target: https://sphinx-hoverxref.readthedocs.io/en/latest/?badge=latest :alt: Documentation status .. |License| image:: https://img.shields.io/github/license/readthedocs/sphinx-hoverxref.svg :target: LICENSE :alt: Repository license
FAQs
Sphinx extension to show tooltips with content embedded when hover a reference.
We found that sphinx-hoverxref demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A flawed sandbox in @nestjs/devtools-integration lets attackers run code on your machine via CSRF, leading to full Remote Code Execution (RCE).
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.
