Documentation

Author: humitos

docs/conf.py

@@ -60,6 +60,9 @@
 
 hoverxref_tooltip_maxwidth = 650
 hoverxref_auto_ref = True
+hoverxref_domains = [
+    'py',
+]
 hoverxref_sphinxtabs = True
 hoverxref_mathjax = True
 

docs/configuration.rst

@@ -36,6 +36,18 @@ For more specific use cases, you can customize these configuration options in yo
 
    Type: bool
 
+.. confval:: hoverxref_domains
+
+   Description: List containing the Sphinx Domain's names where ``hoverxref`` has to be applied.
+
+   .. warning::
+
+      Only Python Domain (``py``) is currently supported.
+
+   Default: ``[]``
+
+   Type: list
+
 .. confval:: hoverxref_tooltip_class
 
    Description: CSS class to add to ``div`` created for the tooltip

docs/usage.rst

@@ -83,6 +83,24 @@ that reStructuredText code will render to:
 
 Show a tooltip to :ref:`usage:Tooltip on all :ref: roles` page.
 
+Tooltip on Sphinx Domains
+-------------------------
+
+You can decide whether use ``hoverxref`` on a particular Sphinx Domain as well.
+An example using Python Domain would be like:
+
+.. code-block:: rst
+
+   :py:class:`hoverxref.extension.HoverXRefStandardDomain`
+
+That will render to:
+
+:py:class:`hoverxref.extension.HoverXRefStandardDomain`
+
+
+To enable ``hoverxref`` on a domain, you need to use the config :confval:`hoverxref_domains`
+indicating which are the domains you desire.
+
 
 Tooltip with content that needs extra rendering steps
 -----------------------------------------------------