Add an example for hoverxref_roles in the configuration page

readthedocs · Apr 24, 2020 · 17d32a3 · 17d32a3
1 parent d8831f6
commit 17d32a3
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -80,6 +80,17 @@ These settings are global and have effect on both, tooltips and modal dialogues.
 
    Type: list
 
+   Example:
+
+   .. code-block:: python
+
+      hoverxref_roles = [
+          'numref',
+          'confval',
+          'setting',
+      ]
+
+
 .. confval:: hoverxref_sphinxtabs
 
    Description: trigger an extra step to render tooltips where its content has a `Sphinx Tabs`_