Sphinx Hoverxref¶
Note
Contents:
- 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
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.
Writing this reStructuredText in your document:
This will :hoverxref:`show a floating window <hoverxref:hoverxref>` in the linked words.
it will be rendered to:
This will show a floating window in the linked words.
Note
The default style (tooltip or modal) is defined by the config :confval:`hoverxref_role_types <hoverxref_role_types>`.
To force the floating window to be a tooltip, you can use :hoverxreftooltip: role instead.
This will :hoverxreftooltip:`show a tooltip <hoverxref:hoverxref>` in the linked words.
it will be rendered to:
This will show a tooltip in the linked words.
To force the floating window to be a modal, you can use :hoverxrefmodal: role instead.
This will :hoverxrefmodal:`show a modal <hoverxref:hoverxref>` in the linked words.
it will be rendered to:
This will show a modal in the linked words.
Tip
These new roles are alias of the ref role and works in the same.
See usage:usage for more detailed information about this and other examples.
See usage for more detailed information about this and other examples.
See Sphinx-Hoverxref:usage for more detailed information about this and other examples.
Reference¶
- Online documentation:
- Source code repository (and issue tracker):
- Badges:
Last change: Tue, 03 Aug 2021 10:25 PM UTC