Make the tests pass with Sphinx 7.x and 8.x

Fixes #43.

Co-authored-by: Yogeswaran Umasankar <kd8mbd@gmail.com>

Author: mitya57

pyproject.toml

@@ -34,7 +34,7 @@ testing = [
     "pytest",
     "pytest-regressions",
     "pytest-cov",
-    "sphinx>=4.0.0,<7",
+    "sphinx>=4.0.0,<9",
 ]
 docs = [
     "sphinx>=4.0.0",

tests/test_render.py

@@ -1,6 +1,7 @@
 """Tests for the rendering."""
 
 import io
+import os
 from pathlib import Path
 from textwrap import dedent
 
@@ -12,8 +13,13 @@
 from autodoc2.render.rst_ import RstRenderer
 from autodoc2.utils import yield_modules
 import pytest
+import sphinx
 from sphinx.testing.util import SphinxTestApp
-from sphinx.testing.util import path as sphinx_path
+
+if sphinx.version_info >= (7, 2):
+    sphinx_path = Path
+else:
+    from sphinx.testing.path import path as sphinx_path
 
 
 @pytest.mark.parametrize(
@@ -94,8 +100,8 @@ def test_sphinx_build(tmp_path: Path, with_rebuild: bool):
     build = tmp_path / "build"
     app = SphinxTestApp(
         buildername="html",
-        srcdir=sphinx_path(source),
-        builddir=sphinx_path(build),
+        srcdir=sphinx_path(os.path.abspath(source)),
+        builddir=sphinx_path(os.path.abspath(build)),
         warning=warnings,
     )
     try:
@@ -137,8 +143,8 @@ def test_sphinx_build(tmp_path: Path, with_rebuild: bool):
     rebuild_warnings = io.StringIO()
     rebuild_app = SphinxTestApp(
         buildername="html",
-        srcdir=sphinx_path(source),
-        builddir=sphinx_path(build),
+        srcdir=sphinx_path(os.path.abspath(source)),
+        builddir=sphinx_path(os.path.abspath(build)),
         warning=rebuild_warnings,
     )
     try:
@@ -210,8 +216,8 @@ def test_sphinx_build_directives(tmp_path: Path, file_regression):
     build = tmp_path / "build"
     app = SphinxTestApp(
         buildername="html",
-        srcdir=sphinx_path(source),
-        builddir=sphinx_path(build),
+        srcdir=sphinx_path(os.path.abspath(source)),
+        builddir=sphinx_path(os.path.abspath(build)),
         warning=warnings,
     )
     try:
@@ -224,6 +230,25 @@ def test_sphinx_build_directives(tmp_path: Path, file_regression):
     doctree = app.env.get_doctree("index")
     doctree["source"] = "index.rst"
     content = "\n".join([line.rstrip() for line in doctree.pformat().splitlines()])
+    if sphinx.version_info < (7, 1):
+        content = content.replace(
+            '<document source="index.rst">',
+            "<document source=\"index.rst\" translation_progress=\"{'total': 0, 'translated': 0}\">",
+        )
+        content = content.replace(
+            '<desc_parameterlist xml:space="preserve">',
+            '<desc_parameterlist multi_line_parameter_list="False" xml:space="preserve">',
+        )
+    if sphinx.version_info < (7, 2):
+        content = content.replace(
+            '<desc classes="py function" desctype="function" domain="py"',
+            '<desc classes="py function" desctype="function" domain="py" no-contents-entry="False" no-index="False" no-index-entry="False" no-typesetting="False"',
+        )
+    if sphinx.version_info < (8, 2):
+        content = content.replace(
+            '<desc_parameterlist multi_line_parameter_list="False"',
+            '<desc_parameterlist multi_line_parameter_list="False" multi_line_trailing_comma="True"',
+        )
     file_regression.check(content, extension=".xml")
 
 

tests/test_render/test_sphinx_build_directives.xml

@@ -1,4 +1,4 @@
-<document source="index.rst">
+<document source="index.rst" translation_progress="{'total': 0, 'translated': 0}">
     <section ids="test" names="test">
         <title>
             Test
@@ -19,13 +19,13 @@
             ```
             ````
         <index entries="('single',\ 'func()\ (in\ module\ package)',\ 'package.func',\ '',\ None)">
-        <desc classes="py function" desctype="function" domain="py" nocontentsentry="False" noindex="False" noindexentry="False" objtype="function">
+        <desc classes="py function" desctype="function" domain="py" no-contents-entry="False" no-index="False" no-index-entry="False" no-typesetting="False" nocontentsentry="False" noindex="False" noindexentry="False" objtype="function">
             <desc_signature _toc_name="func()" _toc_parts="('package', 'func')" class="" classes="sig sig-object" fullname="func" ids="package.func" module="package">
                 <desc_addname classes="sig-prename descclassname" xml:space="preserve">
                     package.
                 <desc_name classes="sig-name descname" xml:space="preserve">
                     func
-                <desc_parameterlist xml:space="preserve">
+                <desc_parameterlist multi_line_parameter_list="False" multi_line_trailing_comma="True" xml:space="preserve">
                     <desc_parameter xml:space="preserve">
                         <desc_sig_name classes="n">
                             a