Restrict to Sphinx 5 (#282)

* Dependencies: require Sphinx 5 or newer

Older Sphinx version have issues with Sphinx's dependencies itself,
which isn't being fixed by the Sphinx project as these old versions are
not maintained.

* refactor: simplify code that maintained Sphinx compatibility

Now we don't support Sphinx < 5, we don't need code that handles older
versions, so we can simplify/delete as appropriate.

* Update the app.require_sphinx value to 5.0

Author: EFord36

.circleci/config.yml

@@ -8,7 +8,7 @@ commands:
         type: string
       sphinx-version:
         type: string
-        default: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,latest"
+        default: "50,53,60,62,70,latest"
     steps:
       - checkout
       # Tox >=4 fails with `ValueError: py310-sphinx{18`
@@ -36,9 +36,6 @@ jobs:
     steps:
       - run-tox:
           version: py310
-          # Do not run tests for Python 3.10 and some versions of Sphinx because it's broken
-          # See https://github.com/sphinx-doc/sphinx/issues/9816
-          sphinx-version: "18,20,21,22,23,24,42,43,44,45,50,latest"
 
 workflows:
   version: 2

hoverxref/extension.py

@@ -151,17 +151,10 @@ 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.
     """
-    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__
+    for listener in app.events.listeners.get('html-page-context'):
+        module_name = inspect.getmodule(listener.handler).__name__
         if module_name == 'sphinx_tabs.tabs':
-            app.disconnect(listener_id)
+            app.disconnect(listener.id)
 
 
 def setup_intersphinx(app, config):
@@ -179,17 +172,10 @@ def setup_intersphinx(app, config):
         # does not have hoverxref intersphinx enabled
         return
 
-    if sphinx.version_info < (3, 0, 0):
-        listeners = list(app.events.listeners.get('missing-reference').items())
-    else:
-        listeners = [
-            (listener.id, listener.handler)
-            for listener in app.events.listeners.get('missing-reference')
-        ]
-    for listener_id, function in listeners:
-        module_name = inspect.getmodule(function).__name__
+    for listener in app.events.listeners.get('missing-reference'):
+        module_name = inspect.getmodule(listener.handler).__name__
         if module_name == 'sphinx.ext.intersphinx':
-            app.disconnect(listener_id)
+            app.disconnect(listener.id)
 
 
 def missing_reference(app, env, node, contnode):
@@ -335,8 +321,8 @@ def deprecated_configs_warning(app, exception):
 def setup(app):
     """Setup ``hoverxref`` Sphinx extension."""
 
-    # ``override`` was introduced in 1.8
-    app.require_sphinx('1.8')
+    # Matches requirement from pyproject.toml
+    app.require_sphinx('5.0')
 
     app.add_config_value('hoverxref_auto_ref', False, 'env')
     app.add_config_value('hoverxref_mathjax', False, 'env')

pyproject.toml

@@ -17,7 +17,7 @@ keywords=[
     "documentation",
 ]
 dependencies = [
-    "sphinx >=1.8",
+    "sphinx >=5.0",
     "sphinxcontrib-jquery",
 ]
 version = "1.3.0"

tests/test_htmltag.py

@@ -156,10 +156,6 @@ def test_python_domain_intersphinx(app, status, warning):
         assert chunk in content
 
 
-@pytest.mark.skipif(
-    sphinx.version_info < (2, 1, 0),
-    reason='sphinxcontrib-bibtex requires Sphinx>=2.1 to work',
-)
 @pytest.mark.sphinx(
     srcdir=bibtexdomainsrcdir,
     confoverrides={
@@ -270,14 +266,9 @@ def test_intersphinx_default_configs(app, status, warning):
         '<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>',
     ]
 
-    if sphinx.version_info >= (4, 0):
-        chunks.extend([
-            '<dt class="sig sig-object py" id="hoverxref.extension.setup">',
-        ])
-    else:
-        chunks.extend([
-            '<dt id="hoverxref.extension.setup">',
-        ])
+    chunks.extend([
+        '<dt class="sig sig-object py" id="hoverxref.extension.setup">',
+    ])
 
 
     for chunk in chunks:

tox.ini

@@ -4,50 +4,23 @@ isolated_build = True
 
 envlist =
   docs
-  py{38,39}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,latest}
-  py{310}-sphinx{18,20,21,22,23,24,42,43,44,45,50,latest}
+  py{38,39,310}-sphinx{50,53,60,62,70,latest}
 
 [testenv]
 deps =
   pytest
   pdbpp
   sphinxcontrib-bibtex
   .
-  sphinx18: sphinx~=1.8.0
-  sphinx20: sphinx~=2.0.0
-  sphinx21: sphinx~=2.1.0
-  sphinx22: sphinx~=2.2.0
-  sphinx23: sphinx~=2.3.0
-  sphinx24: sphinx~=2.4.0
-  sphinx30: sphinx~=3.0.0
-  sphinx31: sphinx~=3.1.0
-  sphinx32: sphinx~=3.2.0
-  sphinx33: sphinx~=3.3.0
-  sphinx34: sphinx~=3.4.0
-  sphinx35: sphinx~=3.5.0
-  sphinx40: sphinx~=4.0.0
-  sphinx41: sphinx~=4.1.0
-  sphinx42: sphinx~=4.2.0
-  sphinx43: sphinx~=4.3.0
-  sphinx44: sphinx~=4.4.0
-  sphinx45: sphinx~=4.5.0
   sphinx50: sphinx~=5.0.0
+  sphinx53: sphinx~=5.3.0
+  sphinx60: sphinx~=6.0.0
+  sphinx62: sphinx~=6.2.0
+  sphinx73: sphinx~=7.0.0
   sphinxlatest: sphinx
 
 commands = pytest {posargs}
 
-# Pin docutils<0.18 for all Python versions using Sphinx 1.x, 2.x, 3.x, 4.0, 4.1
-# since it's incompatible and generating lot of errors
-# https://tox.wiki/en/latest/config.html#generating-environments-conditional-settings
-#
-# Pin jinja2<3.1.0 because there is an incompatibility with the newer version:
-# ImportError: cannot import name 'contextfunction' from 'jinja2'
-[testenv:py{38,39,310}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41}]
-deps =
-  {[testenv]deps}
-  docutils<0.18
-  jinja2<3.1.0
-
 [testenv:py310-sphinx50]
 deps =
   {[testenv]deps}