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.
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.
These new roles are alias of the
ref role and works in the same.
See Usage for more detailed information about this and other examples.
- Online documentation:
- Source code repository (and issue tracker):