Test on newer Sphinx versions

Author: domdfcoding

.github/workflows/python_ci.yml

@@ -28,16 +28,16 @@ jobs:
       fail-fast: False
       matrix:
         config:
-          - {python-version: "3.7", testenvs: "py37-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3},build", experimental: False}
-          - {python-version: "3.8", testenvs: "py38-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1},build", experimental: False}
-          - {python-version: "3.9", testenvs: "py39-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.10", testenvs: "py310-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.11", testenvs: "py311-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.12", testenvs: "py312-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.13", testenvs: "py313-sphinx{6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3},build", experimental: False}
-          - {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "pypy-3.9-v7.3.15", testenvs: "pypy39-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: True}
+          - {python-version: "3.7", testenvs: "py37-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.10", testenvs: "py310-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.11", testenvs: "py311-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.12", testenvs: "py312-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.13", testenvs: "py313-sphinx{6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.9-v7.3.15", testenvs: "pypy39-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci_linux.yml

@@ -29,16 +29,16 @@ jobs:
       fail-fast: False
       matrix:
         config:
-          - {python-version: "3.7", testenvs: "py37-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3},build", experimental: False}
-          - {python-version: "3.8", testenvs: "py38-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1},build", experimental: False}
-          - {python-version: "3.9", testenvs: "py39-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.10", testenvs: "py310-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.11", testenvs: "py311-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.12", testenvs: "py312-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.13", testenvs: "py313-sphinx{6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3},build", experimental: False}
-          - {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "pypy-3.9", testenvs: "pypy39-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: True}
+          - {python-version: "3.7", testenvs: "py37-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.10", testenvs: "py310-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.11", testenvs: "py311-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.12", testenvs: "py312-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.13", testenvs: "py313-sphinx{6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.9", testenvs: "pypy39-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci_macos.yml

@@ -28,16 +28,16 @@ jobs:
       fail-fast: False
       matrix:
         config:
-          - {python-version: "3.7", os-ver: "13", testenvs: "py37-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3},build", experimental: False}
-          - {python-version: "3.8", os-ver: "14", testenvs: "py38-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1},build", experimental: False}
-          - {python-version: "3.9", os-ver: "14", testenvs: "py39-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.10", os-ver: "14", testenvs: "py310-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.11", os-ver: "14", testenvs: "py311-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.12", os-ver: "14", testenvs: "py312-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "3.13", os-ver: "14", testenvs: "py313-sphinx{6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "pypy-3.7", os-ver: "13", testenvs: "pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3},build", experimental: False}
-          - {python-version: "pypy-3.8", os-ver: "14", testenvs: "pypy38-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: False}
-          - {python-version: "pypy-3.9", os-ver: "14", testenvs: "pypy39-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2},build", experimental: True}
+          - {python-version: "3.7", os-ver: "13", testenvs: "py37-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.8", os-ver: "14", testenvs: "py38-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.9", os-ver: "14", testenvs: "py39-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.10", os-ver: "14", testenvs: "py310-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.11", os-ver: "14", testenvs: "py311-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.12", os-ver: "14", testenvs: "py312-sphinx{3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "3.13", os-ver: "14", testenvs: "py313-sphinx{6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.7", os-ver: "13", testenvs: "pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.8", os-ver: "14", testenvs: "pypy38-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: False}
+          - {python-version: "pypy-3.9", os-ver: "14", testenvs: "pypy39-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3,6.0,6.1,6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2},build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

repo_helper.yml

@@ -129,6 +129,11 @@ third_party_version_matrix:
     - 7.0
     - 7.1
     - 7.2
+    - 7.3
+    - 7.4
+    - 8.0
+    - 8.1
+    - 8.2
 #    - latest
 
 exclude_files:

tests/conftest.py

@@ -1,6 +1,6 @@
 # stdlib
 import sys
-from typing import Any, Iterator
+from typing import Any, Dict, Iterator, List, cast
 
 # 3rd party
 import pytest
@@ -12,9 +12,18 @@
 	import types
 	types.Union = types.UnionType
 
+# stdlib
+import pathlib
+
 # 3rd party
+import sphinx
 from sphinx.application import Sphinx
-from sphinx.testing.path import path
+
+if sphinx.version_info >= (7, 2):
+	path = pathlib.Path
+else:
+	# 3rd party
+	from sphinx.testing.path import path  # type: ignore[assignment]
 
 pytest_plugins = ("coincidence", "sphinx.testing.fixtures", "sphinx_toolbox.testing")
 
@@ -99,4 +108,10 @@ def page(content: Any, request: Any) -> Iterator[BeautifulSoup]:
 	pagename = request.param
 	c = (content.outdir / pagename).read_text()
 
-	yield BeautifulSoup(c, "html5lib")
+	soup = BeautifulSoup(c, "html5lib")
+
+	for meta in cast(List[Dict], soup.find_all("meta")):
+		if meta.get("content", '') == "width=device-width, initial-scale=0.9, maximum-scale=0.9":
+			meta.extract()  # type: ignore[attr-defined]
+
+	return soup

tests/doc-test/test-root/conf.py

@@ -4,3 +4,4 @@
 		]
 
 package_root = "dummy_package"
+project = "Python"

tests/requirements.txt

@@ -3,6 +3,7 @@ beautifulsoup4>=4.9.1
 coincidence>=0.2.0
 coverage>=5.1
 coverage-pyver-pragma>=0.2.1
+defusedxml>=0.7.1
 importlib-metadata>=3.6.0
 pygments<=2.13.0,>=2.7.4
 pytest>=6.0.0

tests/test_directive_/test_no_requirements_demo_no_requirements_demo_html_.html

@@ -1,7 +1,8 @@
+{% set permalink = ("Link" if sphinx_version >= (7, 2) else 'Permalink') -%}
 {% set heading = ("heading" if sphinx_version >= (5, 0) else 'headline') -%}
 {% set section = ("section", "section") if docutils_version >= (0, 17) else ('div class="section"', "div") -%}
 <!DOCTYPE html>
-<html{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
+<html{% if sphinx_version >= (7, 2) %} data-content_root="./"{% endif %}{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
  <head>
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
@@ -11,8 +12,9 @@
   {% elif docutils_version[1] == 20 %}<meta content="width=device-width, initial-scale=1" name="viewport"/>
   {% endif %}<title>
    No Requirements Demo — Python  documentation
-  </title>
-  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js">
+  </title>{% if sphinx_version >= (7, 2) %}
+  <script src="_static/documentation_options.js">{% else %}
+  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js">{% endif %}
   </script>{% if sphinx_version < (6, 0) %}
   <script src="_static/jquery.js">
   </script>
@@ -34,15 +36,17 @@
       <{{ section[0] }} id="no-requirements-demo">
        <h1>
         No Requirements Demo
-        <a class="headerlink" href="#no-requirements-demo" title="Permalink to this {{ heading }}">
+        <a class="headerlink" href="#no-requirements-demo" title="{{ permalink }} to this {{ heading }}">
          ¶
         </a>
        </h1>
        <span class="problematic">
         .. extras-require:: extra_f
         :file: empty_requirements.txt
        </span>
-      </{{ section[1] }}>
+      </{{ section[1] }}>{% if sphinx_version >= (8, 1) %}
+      <div class="clearer">
+      </div>{% endif %}
      </div>
     </div>
    </div>

tests/test_directive_/test_output_flit_demo_html_.html

@@ -1,7 +1,8 @@
+{% set permalink = ("Link" if sphinx_version >= (7, 2) else 'Permalink') -%}
 {% set heading = ("heading" if sphinx_version >= (5, 0) else 'headline') -%}
 {% set section = ("section", "section") if docutils_version >= (0, 17) else ('div class="section"', "div") -%}
 <!DOCTYPE html>
-<html{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
+<html{% if sphinx_version >= (7, 2) %} data-content_root="./"{% endif %}{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
  <head>
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
@@ -11,8 +12,9 @@
   {% elif docutils_version[1] == 20 %}<meta content="width=device-width, initial-scale=1" name="viewport"/>
   {% endif %}<title>
    flit Demo — Python  documentation
-  </title>
-  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js">
+  </title>{% if sphinx_version >= (7, 2) %}
+  <script src="_static/documentation_options.js">{% else %}
+  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js">{% endif %}
   </script>{% if sphinx_version < (6, 0) %}
   <script src="_static/jquery.js">
   </script>
@@ -34,7 +36,7 @@
       <{{ section[0] }} id="flit-demo">
        <h1>
         flit Demo
-        <a class="headerlink" href="#flit-demo" title="Permalink to this {{ heading }}">
+        <a class="headerlink" href="#flit-demo" title="{{ permalink }} to this {{ heading }}">
          ¶
         </a>
        </h1>
@@ -74,7 +76,9 @@ <h1>
          </div>
         </blockquote>
        </div>
-      </{{ section[1] }}>
+      </{{ section[1] }}>{% if sphinx_version >= (8, 1) %}
+      <div class="clearer">
+      </div>{% endif %}
      </div>
     </div>
    </div>

tests/test_directive_/test_output_manual_demo_html_.html

@@ -1,7 +1,8 @@
+{% set permalink = ("Link" if sphinx_version >= (7, 2) else 'Permalink') -%}
 {% set heading = ("heading" if sphinx_version >= (5, 0) else 'headline') -%}
 {% set section = ("section", "section") if docutils_version >= (0, 17) else ('div class="section"', "div") -%}
 <!DOCTYPE html>
-<html{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
+<html{% if sphinx_version >= (7, 2) %} data-content_root="./"{% endif %}{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
  <head>
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
@@ -11,8 +12,9 @@
   {% elif docutils_version[1] == 20 %}<meta content="width=device-width, initial-scale=1" name="viewport"/>
   {% endif %}<title>
    Manual Demo — Python  documentation
-  </title>
-  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js">
+  </title>{% if sphinx_version >= (7, 2) %}
+  <script src="_static/documentation_options.js">{% else %}
+  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js">{% endif %}
   </script>{% if sphinx_version < (6, 0) %}
   <script src="_static/jquery.js">
   </script>
@@ -34,7 +36,7 @@
       <{{ section[0] }} id="manual-demo">
        <h1>
         Manual Demo
-        <a class="headerlink" href="#manual-demo" title="Permalink to this {{ heading }}">
+        <a class="headerlink" href="#manual-demo" title="{{ permalink }} to this {{ heading }}">
          ¶
         </a>
        </h1>
@@ -74,7 +76,9 @@ <h1>
          </div>
         </blockquote>
        </div>
-      </{{ section[1] }}>
+      </{{ section[1] }}>{% if sphinx_version >= (8, 1) %}
+      <div class="clearer">
+      </div>{% endif %}
      </div>
     </div>
    </div>