Test cases for intersphinx support

tests/examples/intersphinx/conf.py

@@ -4,14 +4,9 @@
 extensions = [
     'hoverxref.extension',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.autodoc',
 ]
 
-hoverxref_intersphinx = [
-    'python',
-]
-hoverxref_intersphinx_type = 'modal'
-autosectionlabel_prefix_document = True
-
 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),

tests/examples/intersphinx/index.rst

@@ -7,3 +7,10 @@ This is an example page.
 :ref:`This a :ref: to datetime.datetime Python's function using intersphinx <python:datetime-datetime>`.
 
 :ref:`This a :ref: to Config File v2 Read the Docs' page using intersphinx <readthedocs:config-file/v2:python>`.
+
+:py:class:`float`
+
+.. autofunction:: hoverxref.extension.setup
+
+
+:py:func:`hoverxref.extension.setup`

tests/test_htmltag.py

@@ -207,18 +207,88 @@ def test_ignore_refs(app, status, warning):
 @pytest.mark.sphinx(
     srcdir=intersphinxsrc,
 )
-def test_intersphinx(app, status, warning):
+def test_intersphinx_default_configs(app, status, warning):
     app.build()
     path = app.outdir / 'index.html'
     assert path.exists() is True
     content = open(path).read()
 
     chunks = [
-        '<a class="hoverxref modal reference external" data-url="https://docs.python.org/3/tutorial/index.html#tutorial-index" href="https://docs.python.org/3/tutorial/index.html#tutorial-index"><span class="xref std std-ref">This a :ref: to The Python Tutorial using intersphinx</span></a>.',
-        '<a class="hoverxref modal reference external" data-url="https://docs.python.org/3/library/datetime.html#datetime-datetime" href="https://docs.python.org/3/library/datetime.html#datetime-datetime"><span class="xref std std-ref">This a :ref: to datetime.datetime Python’s function using intersphinx</span></a>.</p>',
-        # ``readthedocs`` mapping is not defined for hoverxref intersphinx,
-        # so it only adds the link without the hoverxref classes or data-url attribute
-        '<a class="reference external" href="https://docs.readthedocs.io/en/stable/config-file/v2.html#python" title="(in Read the Docs v5.17.0)"><span class="xref std std-ref">This a :ref: to Config File v2 Read the Docs’ page using intersphinx</span></a>.</p>',
+        '<a class="reference external" href="https://docs.python.org/3/tutorial/index.html#tutorial-index" title="(in Python v3.9)"><span class="xref std std-ref">This a :ref: to The Python Tutorial using intersphinx</span></a>',
+        '<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime-datetime" title="(in Python v3.9)"><span class="xref std std-ref">This a :ref: to datetime.datetime Python’s function using intersphinx</span></a>',
+        '<a class="reference external" href="https://docs.readthedocs.io/en/stable/config-file/v2.html#python" title="(in Read the Docs v5.17.0)"><span class="xref std std-ref">This a :ref: to Config File v2 Read the Docs’ page using intersphinx</span></a>',
+        '<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>',
+        '<dt id="hoverxref.extension.setup">',
+        '<a class="reference internal" href="#hoverxref.extension.setup" title="hoverxref.extension.setup"><code class="xref py py-func docutils literal notranslate"><span class="pre">hoverxref.extension.setup()</span></code></a>',
+    ]
+
+    for chunk in chunks:
+        assert chunk in content
+
+
+@pytest.mark.sphinx(
+    srcdir=intersphinxsrc,
+    confoverrides={
+        'hoverxref_intersphinx': [
+            'python',
+        ],
+    },
+)
+def test_intersphinx_python_mapping(app, status, warning):
+    app.build()
+    path = app.outdir / 'index.html'
+    assert path.exists() is True
+    content = open(path).read()
+
+    chunks = [
+        # Python's links do have hoverxref enabled
+        '<a class="hoverxref tooltip reference external" data-url="https://docs.python.org/3/tutorial/index.html#tutorial-index" href="https://docs.python.org/3/tutorial/index.html#tutorial-index"><span class="xref std std-ref">This a :ref: to The Python Tutorial using intersphinx</span></a>',
+        '<a class="hoverxref tooltip reference external" data-url="https://docs.python.org/3/library/datetime.html#datetime-datetime" href="https://docs.python.org/3/library/datetime.html#datetime-datetime"><span class="xref std std-ref">This a :ref: to datetime.datetime Python’s function using intersphinx</span></a>',
+        '<a class="hoverxref tooltip reference external" data-url="https://docs.python.org/3/library/functions.html#float" href="https://docs.python.org/3/library/functions.html#float"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>',
+
+        # Read the Docs' link does not have hoverxref enabled
+        '<a class="reference external" href="https://docs.readthedocs.io/en/stable/config-file/v2.html#python" title="(in Read the Docs v5.17.0)"><span class="xref std std-ref">This a :ref: to Config File v2 Read the Docs’ page using intersphinx</span></a>',
+
+        # Python's domain does not have hoverxref enabled
+        '<a class="reference internal" href="#hoverxref.extension.setup" title="hoverxref.extension.setup"><code class="xref py py-func docutils literal notranslate"><span class="pre">hoverxref.extension.setup()</span></code></a>',
+    ]
+
+    for chunk in chunks:
+        assert chunk in content
+
+
+@pytest.mark.sphinx(
+    srcdir=intersphinxsrc,
+    confoverrides={
+        'hoverxref_intersphinx': [
+            'readthedocs',
+            'python',
+        ],
+        'hoverxref_intersphinx_types': {
+            'readthedocs': 'modal',
+        },
+        'hoverxref_domains': ['py'],
+        'hoverxref_project': 'test',
+        'hoverxref_version': 'test',
+    },
+)
+def test_intersphinx_all_mappings(app, status, warning):
+    app.build()
+    path = app.outdir / 'index.html'
+    assert path.exists() is True
+    content = open(path).read()
+
+    chunks = [
+        # Python's links do have hoverxref enabled
+        '<a class="hoverxref tooltip reference external" data-url="https://docs.python.org/3/tutorial/index.html#tutorial-index" href="https://docs.python.org/3/tutorial/index.html#tutorial-index"><span class="xref std std-ref">This a :ref: to The Python Tutorial using intersphinx</span></a>',
+        '<a class="hoverxref tooltip reference external" data-url="https://docs.python.org/3/library/datetime.html#datetime-datetime" href="https://docs.python.org/3/library/datetime.html#datetime-datetime"><span class="xref std std-ref">This a :ref: to datetime.datetime Python’s function using intersphinx</span></a>',
+        '<a class="hoverxref tooltip reference external" data-url="https://docs.python.org/3/library/functions.html#float" href="https://docs.python.org/3/library/functions.html#float"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>',
+
+        # Read the Docs' link does have hoverxref enabled
+        '<a class="hoverxref modal reference external" data-url="https://docs.readthedocs.io/en/stable/config-file/v2.html#python" href="https://docs.readthedocs.io/en/stable/config-file/v2.html#python"><span class="xref std std-ref">This a :ref: to Config File v2 Read the Docs’ page using intersphinx</span></a>',
+
+        # Python domain's link does have hoverxref enabled
+        '<a class="hoverxref tooltip reference internal" data-doc="index" data-docpath="/index.html" data-project="test" data-section="hoverxref.extension.setup" data-version="test" href="#hoverxref.extension.setup" title="hoverxref.extension.setup"><code class="xref py py-func docutils literal notranslate"><span class="pre">hoverxref.extension.setup()</span></code></a>',
     ]
 
     for chunk in chunks: