Prefix all CSS classes with hxr-

Avoid collisioning with other CSS frameworks/themes/etc.

See executablebooks/sphinx-book-theme#577
Closes #180

Author: humitos

hoverxref/_static/css/tooltipster.custom.css

@@ -1,4 +1,4 @@
-.hoverxref {
+.hxr-hoverxref {
     border-bottom: 1px dotted;
     border-color: gray;
 }

hoverxref/_static/js/hoverxref.js_t

@@ -96,9 +96,9 @@ $(document).ready(function() {
     // Remove ``title=`` attribute for intersphinx nodes that have hoverxref enabled.
     // It doesn't make sense the browser shows the default tooltip (browser's built-in)
     // and immediately after that our tooltip was shown.
-    $('.hoverxref.external').each(function () { $(this).removeAttr('title') });
+    $('.hxr-hoverxref.external').each(function () { $(this).removeAttr('title') });
 
-    $('.hoverxref.tooltip').tooltipster({
+    $('.hxr-hoverxref.hxr-tooltip').tooltipster({
         theme: {{ hoverxref_tooltip_theme }},
         interactive: {{ 'true' if hoverxref_tooltip_interactive else 'false' }},
         maxWidth: {{ hoverxref_tooltip_maxwidth }},
@@ -235,7 +235,7 @@ $(document).ready(function() {
     };
 
     var delay = {{ hoverxref_modal_hover_delay }}, setTimeoutConst;
-    $('.hoverxref.modal').hover(function(event) {
+    $('.hxr-hoverxref.hxr-modal').hover(function(event) {
         var element = $(this);
         console.debug('Event: ' + event + ' Element: ' + element);
         event.preventDefault();

hoverxref/domains.py

@@ -7,20 +7,21 @@
 
 class HoverXRefBaseDomain:
 
+    css_class_prefix = 'hxr-'
     hoverxref_types = (
         'hoverxref',
         'hoverxreftooltip',
         'hoverxrefmodal',
     )
 
     def _inject_hoverxref_data(self, env, refnode, typ):
-        classes = ['hoverxref']
+        classes = ['hxr-hoverxref']
         type_class = None
         if typ == 'hoverxreftooltip':
-            type_class = 'tooltip'
+            type_class = 'hxr-tooltip'
             classes.append(type_class)
         elif typ == 'hoverxrefmodal':
-            type_class = 'modal'
+            type_class = 'hxr-modal'
             classes.append(type_class)
         if not type_class:
             type_class = env.config.hoverxref_role_types.get(typ)
@@ -33,11 +34,13 @@ def _inject_hoverxref_data(self, env, refnode, typ):
                     default,
                     typ,
                 )
-            classes.append(type_class)
+
+            # Examples: hxr-tooltip, hxr-modal
+            classes.append(f'{self.css_class_prefix}-{type_class}')
 
         refnode.replace_attr('classes', classes)
         # TODO: log something else here, so we can unique identify this node
-        logger.debug(
+        logger.info(
             ':%s: _hoverxref injected. classes=%s',
             typ,
             classes,

hoverxref/extension.py

@@ -264,7 +264,7 @@ def missing_reference(app, env, node, contnode):
         hoverxref_type = hoverxref_type or app.config.hoverxref_default_type
 
         classes = newnode.get('classes')
-        classes.extend(['hoverxref', hoverxref_type])
+        classes.extend(['hxr-hoverxref', hoverxref_type])
         newnode.replace_attr('classes', classes)
 
     return newnode