Skip to content

Commit 0a5de35

Browse files
committed
Improve installation docs
1 parent d5547bc commit 0a5de35

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/installation.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,9 @@ To do this, add this extension to your Sphinx's extensions in the ``conf.py`` fi
3232
3333
3434
After installing the package and adding the extension in the ``conf.py`` file,
35-
all the ``:ref:`` roles will show a tooltip when hovering with the mouse.
35+
you can use ``:hoverxref:`` role to show tooltip when hovering with the mouse.
36+
37+
If you prefer to apply this behavior to *all* your ``:ref:`` in your documentation,
38+
you can use the config :confval:`hoverxref_auto_ref`.
39+
40+
See :ref:`usage:usage` for more use cases and :ref:`configuration:configuration` for a full list of available configs.

0 commit comments

Comments
 (0)