Documentation

Author: humitos

docs/configuration.rst

@@ -16,8 +16,7 @@ These settings are global and have effect on both, tooltips and modal dialogues.
 
 .. confval:: hoverxref_default_types
 
-   Description: Style to use by default when for the embedded content when using ``:hoverxref:`` role.
-   It also affect the style of and ``:ref:``
+   Description: Style to use by default when hover each type of reference (role).
 
    Default: ``{}``
 
@@ -53,6 +52,14 @@ These settings are global and have effect on both, tooltips and modal dialogues.
 
    Type: bool
 
+.. confval:: hoverxref_ignore_refs
+
+   Description: Ignore to add tooltip on specific references. Useful when using :confval:`hoverxref_auto_ref`
+
+   Default: ``['genindex', 'modindex', 'search']``
+
+   Type: list
+
 .. confval:: hoverxref_domains
 
    Description: List containing the Sphinx Domain's names where ``hoverxref`` has to be applied.

hoverxref/extension.py

@@ -250,7 +250,7 @@ def setup(app):
     app.add_config_value('hoverxref_sphinxtabs', False, 'env')
     app.add_config_value('hoverxref_roles', [], 'env')
     app.add_config_value('hoverxref_domains', [], 'env')
-    app.add_config_value('hoverxref_ignore_refs', ['genindex', 'modindex'], 'env')
+    app.add_config_value('hoverxref_ignore_refs', ['genindex', 'modindex', 'search'], 'env')
     app.add_config_value('hoverxref_default_types', {}, 'env')
     app.add_config_value('hoverxref_default_type', 'tooltip', 'env')
     app.add_config_value('hoverxref_api_host', 'https://readthedocs.org', 'env')