More flexibility for floating window styles

Use a dictionary to configure each role style: ref, confval, mod, class, etc

Author: humitos

docs/conf.py

@@ -65,6 +65,14 @@
 hoverxref_roles = [
     'confval',
 ]
+
+hoverxref_default_types = {
+    'hoverxref': 'tooltip',
+    'ref': 'modal',
+    'confval': 'tooltip',
+    'mod': 'modal',
+    'class': 'modal',
+}
 hoverxref_domains = [
     'py',
 ]

docs/configuration.rst

@@ -14,9 +14,30 @@ General settings
 
 These settings are global and have effect on both, tooltips and modal dialogues.
 
-.. confval:: hoverxref_type
+.. confval:: hoverxref_default_types
 
-   Description: How to display the embedded content. As a Tooltip or as a Modal dialogue.
+   Description: Style to use by default when for the embedded content when using ``:hoverxref:`` role.
+   It also affect the style of and ``:ref:``
+
+   Default: ``{}``
+
+   Example:
+
+   .. code-block:: python
+
+      {
+          'hoverxref': 'modal',
+          'ref': 'modal',
+          'confval': 'tooltip',
+          'mod': 'tooltip',  # for Python Domain
+          'class': 'tooltip',  # for Python Domain
+      }
+
+   Type: dictionary
+
+.. confval:: hoverxref_default_type
+
+   Description: Default style when the specific one was not found in :confval:`hoverxref_default_types`.
 
    Default: ``tooltip``
 
@@ -26,7 +47,7 @@ These settings are global and have effect on both, tooltips and modal dialogues.
 
 .. confval:: hoverxref_auto_ref
 
-   Description: Make all ``:ref:`` role to show a tooltip
+   Description: Make all ``:ref:`` role to show a tooltip.
 
    Default: ``False``
 

docs/index.rst

@@ -27,7 +27,7 @@ We currently support two different types of floating windows: Tooltip and Modal.
 
       .. note::
 
-         The default style (tooltip or modal) is defined by the config :confval:`hoverxref_type <hoverxref_type>`.
+         The default style (tooltip or modal) is defined by the config :confval:`hoverxref_default_types <hoverxref_default_types>`.
 
 
    .. tab:: Tooltip style

hoverxref/domains.py

@@ -18,8 +18,28 @@ def _is_hoverxref_configured(self, env):
         return project and version
 
     def _inject_hoverxref_data(self, env, refnode, typ, docname, docpath, labelid):
-        type_class = 'tooltip' if typ == 'hoverxreftooltip' else ('modal' if typ == 'hoverxrefmodal' else env.config.hoverxref_default_type)
-        refnode.replace_attr('classes', ['hoverxref', type_class])
+        classes = ['hoverxref']
+        type_class = None
+        if typ == 'hoverxreftooltip':
+            type_class = 'tooltip'
+            classes.append(type_class)
+        elif typ == 'hoverxrefmodal':
+            type_class = 'modal'
+            classes.append(type_class)
+        if not type_class:
+            type_class = env.config.hoverxref_default_types.get(typ)
+            if not type_class:
+                default = env.config.hoverxref_default_type
+                type_class = default
+                logger.warning(
+                    'Using default style for unknown typ. '
+                    'Define it in hoverxref_default_types. typ=%s style=%s',
+                    typ,
+                    default,
+                )
+            classes.append(type_class)
+
+        refnode.replace_attr('classes', classes)
 
         project = env.config.hoverxref_project
         version = env.config.hoverxref_version

hoverxref/extension.py

@@ -230,7 +230,10 @@ 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_default_types', {}, 'env')
     app.add_config_value('hoverxref_default_type', 'tooltip', 'env')
+
     app.add_config_value('hoverxref_api_host', 'https://readthedocs.org', 'env')
 
     # Tooltipster settings

tests/test_htmltag.py

@@ -179,7 +179,7 @@ def test_python_domain(app, status, warning):
         'hoverxref_default_type': 'modal',
     },
 )
-def test_project_version_settings(app, status, warning):
+def test_default_types(app, status, warning):
     app.build()
     path = app.outdir / 'index.html'
     assert path.exists() is True