Merge branch 'master' of github.com:humitos/sphinx-hoverxref into humitos/send-docpath

Author: humitos

.travis.yml

@@ -3,6 +3,7 @@ dist: xenial
 python:
   - 3.6
   - 3.7
+  - 3.8
 install:
   pip install tox-travis
 script:

MANIFEST.in

@@ -5,3 +5,7 @@ include hoverxref/_static/js/tooltipster.bundle.min.js
 include hoverxref/_static/css/tooltipster.bundle.min.css
 include hoverxref/_static/css/tooltipster-sideTip-shadow.min.css
 include hoverxref/_static/css/tooltipster.custom.css
+include hoverxref/_static/css/tooltipster-sideTip-light.min.css
+include hoverxref/_static/css/tooltipster-sideTip-borderless.min.css
+include hoverxref/_static/css/tooltipster-sideTip-noir.min.css
+include hoverxref/_static/css/tooltipster-sideTip-punk.min.css

docs/conf.py

@@ -128,7 +128,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

docs/requirements.txt

@@ -1,5 +1,5 @@
 sphinx==1.8.5  # pyup: ignore
-sphinx-autoapi==1.2.1
+sphinx-autoapi==1.3.0
 sphinx-rtd-theme==0.4.3
 sphinx-tabs==1.1.13
 sphinx-prompt==1.1.0

docs/usage.rst

@@ -68,11 +68,11 @@ An example using Python Domain would be like:
 
 .. code-block:: rst
 
-   :py:class:`hoverxref.domains.HoverXRefStandardDomain`
+   :py:class:`hoverxref.domains.HoverXRefStandardDomainMixin`
 
 That will render to:
 
-:py:class:`hoverxref.domains.HoverXRefStandardDomain`
+:py:class:`hoverxref.domains.HoverXRefStandardDomainMixin`
 
 
 To enable ``hoverxref`` on a domain, you need to use the config :confval:`hoverxref_domains`

hoverxref/domains.py

@@ -1,5 +1,3 @@
-from sphinx.domains.python import PythonDomain
-from sphinx.domains.std import StandardDomain
 from sphinx.util import logging
 from .utils import get_ref_xref_data, get_ref_obj_data
 
@@ -32,7 +30,7 @@ def _get_docpath(self, builder, docname):
         return docpath
 
 
-class HoverXRefPythonDomain(HoverXRefBaseDomain, PythonDomain):
+class HoverXRefPythonDomainMixin(HoverXRefBaseDomain):
 
     def resolve_xref(self, env, fromdocname, builder, type, target, node, contnode):
         refnode = super().resolve_xref(env, fromdocname, builder, type, target, node, contnode)
@@ -59,9 +57,9 @@ def resolve_xref(self, env, fromdocname, builder, type, target, node, contnode):
         return refnode
 
 
-class HoverXRefStandardDomain(HoverXRefBaseDomain, StandardDomain):
+class HoverXRefStandardDomainMixin(HoverXRefBaseDomain):
     """
-    Override ``StandardDomain`` to save the values after the xref resolution.
+    Mixin for ``StandardDomain`` to save the values after the xref resolution.
 
     ``:ref:`` are treating as a different node in Sphinx
     (``sphinx.addnodes.pending_xref``). These nodes are translated to regular

hoverxref/extension.py

@@ -1,12 +1,14 @@
 import os
 import inspect
+import types
 from docutils import nodes
+import sphinx
 from sphinx.roles import XRefRole
 from sphinx.util.fileutil import copy_asset
 
 from . import version
-from .domains import HoverXRefPythonDomain, HoverXRefStandardDomain
-from .translators import HoverXRefHTMLTranslator
+from .domains import HoverXRefPythonDomainMixin, HoverXRefStandardDomainMixin
+from .translators import HoverXRefHTMLTranslatorMixin
 
 ASSETS_FILES = [
     'js/hoverxref.js_t',  # ``_t`` tells Sphinx this is a template
@@ -53,6 +55,13 @@ def copy_asset_files(app, exception):
 
 
 def setup_domains(app, config):
+    """
+    Override domains respecting the one defined (if any).
+
+    We create a new class by inheriting the Sphinx Domain already defined
+    and our own ``HoverXRef...DomainMixin`` that includes the logic for
+    ``_hoverxref`` attributes.
+    """
     # Add ``hoverxref`` role replicating the behavior of ``ref``
     app.add_role_to_domain(
         'std',
@@ -63,10 +72,27 @@ def setup_domains(app, config):
             warn_dangling=True,
         ),
     )
-    app.add_domain(HoverXRefStandardDomain, override=True)
 
-    if 'py' in config.hoverxref_domains:
-        app.add_domain(HoverXRefPythonDomain, override=True)
+    domain = types.new_class(
+        'HoverXRefStandardDomain',
+        (
+            HoverXRefStandardDomainMixin,
+            app.registry.domains.get('std'),
+        ),
+        {}
+    )
+    app.add_domain(domain, override=True)
+
+    if 'py' in app.config.hoverxref_domains:
+        domain = types.new_class(
+            'HoverXRefPythonDomain',
+            (
+                HoverXRefPythonDomainMixin,
+                app.registry.domains.get('py'),
+            ),
+            {}
+        )
+        app.add_domain(domain, override=True)
 
 
 def setup_sphinx_tabs(app, config):
@@ -76,13 +102,55 @@ def setup_sphinx_tabs(app, config):
     Sphinx Tabs removes the CSS/JS from pages that does not use the directive.
     Although, we need them to use inside the tooltip.
     """
-    listeners = list(app.events.listeners.get('html-page-context').items())
+    if sphinx.version_info < (3, 0, 0):
+        listeners = list(app.events.listeners.get('html-page-context').items())
+    else:
+        listeners = [
+            (listener.id, listener.handler)
+            for listener in app.events.listeners.get('html-page-context')
+        ]
     for listener_id, function in listeners:
         module_name = inspect.getmodule(function).__name__
         if module_name == 'sphinx_tabs.tabs':
             app.disconnect(listener_id)
 
 
+def setup_translators(app):
+    """
+    Override translators respecting the one defined (if any).
+
+    We create a new class by inheriting the Sphinx Translator already defined
+    and our own ``HoverXRefHTMLTranslatorMixin`` that includes the logic to
+    ``_hoverxref`` attributes.
+    """
+    if not app.registry.translators.items():
+        translator = types.new_class(
+            'HoverXRefHTMLTranslator',
+            (
+                HoverXRefHTMLTranslatorMixin,
+                app.builder.default_translator_class,
+            ),
+            {},
+        )
+        app.set_translator(app.builder.name, translator, override=True)
+    else:
+        for name, klass in app.registry.translators.items():
+            if app.builder.format != 'html':
+                # Skip translators that are not HTML
+                continue
+
+            translator = types.new_class(
+                'HoverXRefHTMLTranslator',
+                (
+                    HoverXRefHTMLTranslatorMixin,
+                    klass,
+                ),
+                {},
+            )
+            app.set_translator(name, translator, override=True)
+
+
+
 def setup(app):
     """Setup ``hoverxref`` Sphinx extension."""
 
@@ -109,13 +177,7 @@ def setup(app):
     app.add_config_value('hoverxref_tooltip_content', 'Loading...', 'env')
     app.add_config_value('hoverxref_tooltip_class', 'rst-content', 'env')
 
-    app.set_translator('html', HoverXRefHTMLTranslator, override=True)
-
-    # Read the Docs use ``readthedocs`` as the name of the build, so we need to
-    # replace this as well
-    app.set_translator('readthedocs', HoverXRefHTMLTranslator, override=True)
-    app.set_translator('readthedocsdirhtml', HoverXRefHTMLTranslator, override=True)
-
+    app.connect('builder-inited', setup_translators)
     app.connect('config-inited', setup_domains)
     app.connect('config-inited', setup_sphinx_tabs)
     app.connect('build-finished', copy_asset_files)

hoverxref/translators.py

@@ -1,13 +1,12 @@
-from sphinx.writers.html import HTMLTranslator
 from sphinx.util import logging
 
 logger = logging.getLogger(__name__)
 
 
-class HoverXRefHTMLTranslator(HTMLTranslator):
+class HoverXRefHTMLTranslatorMixin:
 
     """
-    Override ``HTMLTranslator`` to render extra data saved in reference nodes.
+    Mixin ``HTMLTranslator`` to render extra data saved in reference nodes.
 
     It adds all the values saved under ``_hoverxref`` as attributes of the HTML
     reference tag.

tests/examples/python-domain/api.rst

@@ -3,7 +3,7 @@
 API
 ===
 
-.. autoclass:: hoverxref.extension.HoverXRefStandardDomain
+.. autoclass:: hoverxref.extension.HoverXRefStandardDomainMixin
 
 
 .. automodule:: hoverxref.extension

tests/examples/python-domain/index.rst

@@ -3,7 +3,7 @@ Python Domain
 
 This is an example page with a Python Domain role usage.
 
-:py:class:`This is a :py:class: role to a Python object <hoverxref.extension.HoverXRefStandardDomain>`.
+:py:class:`This is a :py:class: role to a Python object <hoverxref.extension.HoverXRefStandardDomainMixin>`.
 
 :py:mod:`hoverxref.extension`