sphinx-hoverxref

[coding-to-music]

https://sphinx-hoverxref.readthedocs.io/en/latest/

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

[coding-to-music]

https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html

https://sphinx-hoverxref.readthedocs.io/en/latest/installation.html

[coding-to-music]

Sphinx Hoverxref

https://raw.githubusercontent.com/readthedocs/sphinx-hoverxref/master/docs/index.rst

Welcome to sphinx-hoverxref! https://sphinx-hoverxref.readthedocs.io/en/latest/
installation https://sphinx-hoverxref.readthedocs.io/en/latest/installation.html
usage https://sphinx-hoverxref.readthedocs.io/en/latest/usage.html
configuration https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html
development https://sphinx-hoverxref.readthedocs.io/en/latest/development.html
API Reference https://sphinx-hoverxref.readthedocs.io/en/latest/autoapi/hoverxref/index.html

autoapi/hoverxref/index

Welcome to sphinx-hoverxref!

sphinx-hoverxref is a Sphinx_ extension to show a floating window (tooltips or modal dialogues) on the cross references of the documentation embedding the content of the linked section on them. With sphinx-hoverxref, you don't need to click a link to see what's in there.

Usage

To show a floating window, use the role hoverxref to link to any document or section and embed its content into it.
We currently support two different types of floating windows: Tooltip and Modal.

.. tabs::

.. tab:: Default

  Writing this reStructuredText in your document:

  .. code-block:: rst

     This will :hoverxref:`show a floating window <hoverxref:hoverxref>` in the linked words.

  it will be rendered to:

  This will :hoverxref:`show a floating window <hoverxref:hoverxref>` in the linked words.

  .. note::

     The default style (tooltip or modal) is defined by the config :confval:`hoverxref_role_types <hoverxref_role_types>`.

.. tab:: Tooltip style

  To *force* the floating window to be a tooltip, you can use ``:hoverxreftooltip:`` role instead.

  .. code-block:: rst

     This will :hoverxreftooltip:`show a tooltip <hoverxref:hoverxref>` in the linked words.

  it will be rendered to:

  This will :hoverxreftooltip:`show a tooltip <hoverxref:hoverxref>` in the linked words.

.. tab:: Modal style

  To *force* the floating window to be a modal, you can use ``:hoverxrefmodal:`` role instead.

  .. code-block:: rst

     This will :hoverxrefmodal:`show a modal <hoverxref:hoverxref>` in the linked words.

  it will be rendered to:

  This will :hoverxrefmodal:`show a modal <hoverxref:hoverxref>` in the linked words.

.. tip::

These new roles are alias of the ref role and works in the same.
See :ref:usage:usage for more detailed information about this and other examples.

---

Reference

Online documentation:
https://sphinx-hoverxref.readthedocs.io/

Source code repository (and issue tracker):
https://github.com/readthedocs/sphinx-hoverxref/

Badges:
|Build| |PyPI version| |Docs badge| |License|

.. _Sphinx: https://www.sphinx-doc.org/
.. _Read the Docs: https://readthedocs.org

.. |Build| image:: https://travis-ci.org/readthedocs/sphinx-hoverxref.svg?branch=master
:target: https://travis-ci.org/readthedocs/sphinx-hoverxref
:alt: Build status
.. |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

Last change: |today|