Skip to content

Commit 17d32a3

Browse files
committed
Add an example for hoverxref_roles in the configuration page
1 parent d8831f6 commit 17d32a3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/configuration.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,17 @@ These settings are global and have effect on both, tooltips and modal dialogues.
8080

8181
Type: list
8282

83+
Example:
84+
85+
.. code-block:: python
86+
87+
hoverxref_roles = [
88+
'numref',
89+
'confval',
90+
'setting',
91+
]
92+
93+
8394
.. confval:: hoverxref_sphinxtabs
8495

8596
Description: trigger an extra step to render tooltips where its content has a `Sphinx Tabs`_

0 commit comments

Comments
 (0)