Add hoverxref_ignore_refs to ignore user-defined references

With this config, the user can decide to not show tooltips on some
specific references by adding the targets of these in the list of
ignored references.

Author: humitos

hoverxref/domains.py

@@ -31,6 +31,13 @@ def resolve_xref(self, env, fromdocname, builder, type, target, node, contnode):
         if refnode is None:
             return
 
+        if target in env.config.hoverxref_ignore_refs:
+            logger.info(
+                'Ignoring reference in hoverxref_ignore_refs. target=%s',
+                target,
+            )
+            return refnode
+
         modname = node.get('py:module')
         clsname = node.get('py:class')
         searchmode = node.hasattr('refspecific') and 1 or 0
@@ -74,6 +81,13 @@ def _resolve_ref_xref(self, env, fromdocname, builder, typ, target, node, contno
         if refnode is None:
             return
 
+        if target in env.config.hoverxref_ignore_refs:
+            logger.info(
+                'Ignoring reference in hoverxref_ignore_refs. target=%s',
+                target,
+            )
+            return refnode
+
         if not self._is_hoverxref_configured(env) and typ == 'hoverxref':
             # Using ``:hoverxref:`` role without having hoverxref configured
             # properly. Log a warning.

hoverxref/extension.py

@@ -166,6 +166,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_tooltip_api_host', 'https://readthedocs.org', 'env')
     app.add_config_value('hoverxref_tooltip_theme', ['tooltipster-shadow', 'tooltipster-shadow-custom'], 'env')