https://github.com/readthedocs/sphinx-hoverxref

Sphinx extension to show tooltips with content embedded when hover a reference.
https://github.com/readthedocs/sphinx-hoverxref

documentation hoverxref html links modal-dialogs references sphinx sphinx-extension tooltip

Last synced: 4 days ago
JSON representation

Sphinx extension to show tooltips with content embedded when hover a reference.

• Host: GitHub
• URL: https://github.com/readthedocs/sphinx-hoverxref
• Owner: readthedocs
• License: mit
• Created: 2019-06-02T13:52:53.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T00:17:57.000Z (16 days ago)
• Last Synced: 2024-10-28T04:16:07.324Z (16 days ago)
• Topics: documentation, hoverxref, html, links, modal-dialogs, references, sphinx, sphinx-extension, tooltip
• Language: Python
• Homepage: https://sphinx-hoverxref.readthedocs.io/
• Size: 2.05 MB
• Stars: 96
• Watchers: 9
• Forks: 41
• Open Issues: 37
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
|PyPI version| |Docs badge| |License|

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

-------

.. image:: docs/sphinx-hoverxref-example.png

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:

.. code-block:: python

   extensions = [

    # ... other extensions here

    'hoverxref.extension',

   ]

Documentation

-------------

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