From a85d453e5cbbdef9ef7a68a97579f1b6ddddae4a Mon Sep 17 00:00:00 2001
From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com>
Date: Fri, 7 Feb 2025 18:05:21 +0000
Subject: [PATCH 01/33] Updated files with 'repo_helper'. (#172)
Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com>
---
README.rst | 2 +-
doc-source/index.rst | 2 +-
tox.ini | 2 ++
3 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/README.rst b/README.rst
index 8726af9..9c1153a 100644
--- a/README.rst
+++ b/README.rst
@@ -109,7 +109,7 @@ sphinx-toolbox
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/commit/master
:alt: GitHub last commit
-.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
+.. |maintained| image:: https://img.shields.io/maintenance/yes/2025
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-toolbox
diff --git a/doc-source/index.rst b/doc-source/index.rst
index d5e8d8a..56f04f2 100644
--- a/doc-source/index.rst
+++ b/doc-source/index.rst
@@ -114,7 +114,7 @@ sphinx-toolbox
:last-commit:
:alt: GitHub last commit
- .. |maintained| maintained-shield:: 2024
+ .. |maintained| maintained-shield:: 2025
:alt: Maintenance
.. |pypi-downloads| pypi-shield::
diff --git a/tox.ini b/tox.ini
index 33557e9..25d501c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -230,11 +230,13 @@ toplevel = sphinx_toolbox
package = sphinx_toolbox
[testenv:py312-sphinx{3.2,3.3,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}]
+download = True
setenv =
PYTHONDEVMODE=1
PIP_DISABLE_PIP_VERSION_CHECK=1
[testenv:py313-dev-sphinx{3.2,3.3,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}]
+download = True
setenv =
PYTHONDEVMODE=1
PIP_DISABLE_PIP_VERSION_CHECK=1
From 262d19b01680fffae6ac62285f1f8a7c8440b411 Mon Sep 17 00:00:00 2001
From: Dominic Davis-Foster
-
+ {% if sphinx_version >= (8, 1) %}
+
missing.txt
- + {% if sphinx_version >= (8, 1) %} +- + {% if sphinx_version >= (8, 1) %} +
- + {% if sphinx_version >= (8, 1) %} +
- + {% if sphinx_version >= (8, 1) %} +
- + {% if sphinx_version >= (8, 1) %} +
- + {% if sphinx_version >= (8, 1) %} +
- + {% if sphinx_version >= (8, 1) %} +
+
int
@@ -359,7 +359,7 @@
(
-
+
int
@@ -466,7 +466,7 @@
(
-
+
int
@@ -683,7 +683,7 @@
(
-
+
int
@@ -793,7 +793,7 @@
(
-
+
int
diff --git a/tests/test_output/test_output_/test_html_output_overloads_html_.html b/tests/test_output/test_output_/test_html_output_overloads_html_.html
index 255e148..4317ba7 100644
--- a/tests/test_output/test_output_/test_html_output_overloads_html_.html
+++ b/tests/test_output/test_output_/test_html_output_overloads_html_.html
@@ -205,7 +205,7 @@
:
-
+
int
@@ -213,7 +213,7 @@
) ->
-
+
str
@@ -236,13 +236,13 @@
:
-
+
slice
- ) ->{% if python_version >= (3, 12) %}
+ ) ->{% if python_version >= (9, 9) %}
List[str]
@@ -257,7 +257,7 @@
[
-
+
str
@@ -454,7 +454,7 @@
:
-
+
int
@@ -462,7 +462,7 @@
) ->
-
+
str
@@ -485,13 +485,13 @@
:
-
+
slice
- ) ->{% if python_version >= (3, 12) %}
+ ) ->{% if python_version >= (9, 9) %}
List[str]
@@ -506,7 +506,7 @@
[
-
+
str
@@ -788,7 +788,7 @@
cls
- :{% if python_version >= (3, 12) %}
+ :{% if python_version >= (9, 9) %}
Type[object]
@@ -833,7 +833,7 @@
= β¦,
to_key
- {% endif %}{% if python_version >= (3, 12) %}
+ {% endif %}{% if python_version >= (9, 9) %}
@@ -890,7 +890,7 @@
= None,
from_key
- {% if python_version >= (3, 12) %}
+ {% if python_version >= (9, 9) %}
:
@@ -905,7 +905,7 @@
:
-
+
str
diff --git a/tox.ini b/tox.ini
index 54671f5..646451a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -229,19 +229,6 @@ ignore = W002
toplevel = sphinx_toolbox
package = sphinx_toolbox
-[testenv:py312-sphinx{3.2,3.3,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}]
-download = True
-setenv =
- PYTHONDEVMODE=1
- PIP_DISABLE_PIP_VERSION_CHECK=1
-
-[testenv:py313-sphinx{3.2,3.3,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}]
-download = True
-setenv =
- PYTHONDEVMODE=1
- PIP_DISABLE_PIP_VERSION_CHECK=1
- UNSAFE_PYO3_SKIP_VERSION_CHECK=1
-
[testenv]
setenv =
PYTHONDEVMODE=1
@@ -368,8 +355,3 @@ filterwarnings =
always:The `docutils.parsers.rst.directive.html` module will be removed in Docutils 2.0.:DeprecationWarning
always:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning
always:nodes.Node.traverse\(\) is obsoleted by Node.findall\(\).:PendingDeprecationWarning
-
-[testenv:py{py37,py38,py39}-sphinx{3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4,4.5,5.0}]
-commands =
- python --version
- python -m pytest -p no:cov -r aR tests/ {posargs}
From b8c08ecf18ec6e2fab72d86da94fd2acb3394113 Mon Sep 17 00:00:00 2001
From: Dominic Davis-Foster
Date: Wed, 16 Apr 2025 16:37:33 +0100
Subject: [PATCH 14/33] Fix tests on Python 3.13
---
...test_html_output_autonamedtuple_html_.html | 10 +++----
.../test_html_output_overloads_html_.html | 28 +++++++++----------
2 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/tests/test_output/test_output_/test_html_output_autonamedtuple_html_.html b/tests/test_output/test_output_/test_html_output_autonamedtuple_html_.html
index 9932b46..09ef9ba 100644
--- a/tests/test_output/test_output_/test_html_output_autonamedtuple_html_.html
+++ b/tests/test_output/test_output_/test_html_output_autonamedtuple_html_.html
@@ -214,7 +214,7 @@
(
-
+
int
@@ -359,7 +359,7 @@
(
-
+
int
@@ -466,7 +466,7 @@
(
-
+
int
@@ -683,7 +683,7 @@
(
-
+
int
@@ -793,7 +793,7 @@
(
-
+
int
diff --git a/tests/test_output/test_output_/test_html_output_overloads_html_.html b/tests/test_output/test_output_/test_html_output_overloads_html_.html
index 4317ba7..8f7259b 100644
--- a/tests/test_output/test_output_/test_html_output_overloads_html_.html
+++ b/tests/test_output/test_output_/test_html_output_overloads_html_.html
@@ -205,7 +205,7 @@
:
-
+
int
@@ -213,7 +213,7 @@
) ->
-
+
str
@@ -236,13 +236,13 @@
:
-
+
slice
- ) ->{% if python_version >= (9, 9) %}
+ ) ->{% if python_version >= (3, 13) %}
List[str]
@@ -257,7 +257,7 @@
[
-
+
str
@@ -454,7 +454,7 @@
:
-
+
int
@@ -462,7 +462,7 @@
) ->
-
+
str
@@ -485,13 +485,13 @@
:
-
+
slice
- ) ->{% if python_version >= (9, 9) %}
+ ) ->{% if python_version >= (3, 13) %}
List[str]
@@ -506,7 +506,7 @@
[
-
+
str
@@ -788,7 +788,7 @@
cls
- :{% if python_version >= (9, 9) %}
+ :{% if python_version >= (3, 13) %}
Type[object]
@@ -833,7 +833,7 @@
= β¦,
to_key
- {% endif %}{% if python_version >= (9, 9) %}
+ {% endif %}{% if python_version >= (3, 13) %}
@@ -890,7 +890,7 @@
= None,
from_key
- {% if python_version >= (9, 9) %}
+ {% if python_version >= (3, 13) %}
:
@@ -905,7 +905,7 @@
:
-
+
str
From 30d84f96fba1736868cd98b4c274e266f0f5f829 Mon Sep 17 00:00:00 2001
From: Dominic Davis-Foster
Date: Thu, 17 Apr 2025 10:39:05 +0100
Subject: [PATCH 15/33] Don't test Python 3.12 with older Sphinx versions
(require distutils)
---
.github/workflows/python_ci.yml | 2 +-
.github/workflows/python_ci_linux.yml | 2 +-
.github/workflows/python_ci_macos.yml | 2 +-
repo_helper.yml | 9 +++++++++
tox.ini | 4 ++--
5 files changed, 14 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
index 3a3e043..95bc1b8 100644
--- a/.github/workflows/python_ci.yml
+++ b/.github/workflows/python_ci.yml
@@ -33,7 +33,7 @@ jobs:
- {python-version: "3.9", testenvs: "py39-sphinx{3.2,3.3,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},build", experimental: False}
- {python-version: "3.10", testenvs: "py310-sphinx{3.2,3.3,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},build", experimental: False}
- {python-version: "3.11", testenvs: "py311-sphinx{3.2,3.3,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.2,3.3,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{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},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},build", experimental: False}
diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml
index 6e5d72c..e03e6d5 100644
--- a/.github/workflows/python_ci_linux.yml
+++ b/.github/workflows/python_ci_linux.yml
@@ -34,7 +34,7 @@ jobs:
- {python-version: "3.9", testenvs: "py39-sphinx{3.2,3.3,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},build", experimental: False}
- {python-version: "3.10", testenvs: "py310-sphinx{3.2,3.3,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},build", experimental: False}
- {python-version: "3.11", testenvs: "py311-sphinx{3.2,3.3,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.2,3.3,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{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},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},build", experimental: False}
diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
index d3c87a6..622f9f5 100644
--- a/.github/workflows/python_ci_macos.yml
+++ b/.github/workflows/python_ci_macos.yml
@@ -33,7 +33,7 @@ jobs:
- {python-version: "3.9", testenvs: "py39-sphinx{3.2,3.3,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},build", experimental: False}
- {python-version: "3.10", testenvs: "py310-sphinx{3.2,3.3,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},build", experimental: False}
- {python-version: "3.11", testenvs: "py311-sphinx{3.2,3.3,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.2,3.3,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{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},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},build", experimental: False}
diff --git a/repo_helper.yml b/repo_helper.yml
index bc541c9..ae7dc7b 100644
--- a/repo_helper.yml
+++ b/repo_helper.yml
@@ -60,6 +60,15 @@ python_versions:
- 8.2
"3.11":
"3.12":
+ matrix_exclude:
+ sphinx:
+ - 3.2
+ - 3.3
+ - 3.4
+ - 3.5
+ - 4.0
+ - 4.1
+ - 4.2
"3.13":
matrix_exclude:
sphinx:
diff --git a/tox.ini b/tox.ini
index 646451a..e1d223a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -26,7 +26,7 @@ envlist =
py39-sphinx{3.2,3.3,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}
py310-sphinx{3.2,3.3,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}
py311-sphinx{3.2,3.3,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}
- py312-sphinx{3.2,3.3,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}
+ py312-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}
py313-sphinx{6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2}
pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3}
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}
@@ -48,7 +48,7 @@ test =
py39-sphinx{3.2,3.3,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}
py310-sphinx{3.2,3.3,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}
py311-sphinx{3.2,3.3,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}
- py312-sphinx{3.2,3.3,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}
+ py312-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}
py313-sphinx{6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,8.2}
pypy37-sphinx{4.3,4.4,4.5,5.0,5.1,5.2,5.3}
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}
From 1cf39a23237e52c767864b04cd6cb4f63c51f679 Mon Sep 17 00:00:00 2001
From: Dominic Davis-Foster
Date: Mon, 28 Apr 2025 15:56:22 +0100
Subject: [PATCH 16/33] Fix tests on Python 3.12
---
.../test_html_output_overloads_html_.html | 28 +++++++++----------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/tests/test_output/test_output_/test_html_output_overloads_html_.html b/tests/test_output/test_output_/test_html_output_overloads_html_.html
index 8f7259b..255e148 100644
--- a/tests/test_output/test_output_/test_html_output_overloads_html_.html
+++ b/tests/test_output/test_output_/test_html_output_overloads_html_.html
@@ -205,7 +205,7 @@
:
-
+
int
@@ -213,7 +213,7 @@
) ->
-
+
str
@@ -236,13 +236,13 @@
:
-
+
slice
- ) ->{% if python_version >= (3, 13) %}
+ ) ->{% if python_version >= (3, 12) %}
List[str]
@@ -257,7 +257,7 @@
[
-
+
str
@@ -454,7 +454,7 @@
:
-
+
int
@@ -462,7 +462,7 @@
) ->
-
+
str
@@ -485,13 +485,13 @@
:
-
+
slice
- ) ->{% if python_version >= (3, 13) %}
+ ) ->{% if python_version >= (3, 12) %}
List[str]
@@ -506,7 +506,7 @@
[
-
+
str
@@ -788,7 +788,7 @@
cls
- :{% if python_version >= (3, 13) %}
+ :{% if python_version >= (3, 12) %}
Type[object]
@@ -833,7 +833,7 @@
= β¦,
to_key
- {% endif %}{% if python_version >= (3, 13) %}
+ {% endif %}{% if python_version >= (3, 12) %}
@@ -890,7 +890,7 @@
= None,
from_key
- {% if python_version >= (3, 13) %}
+ {% if python_version >= (3, 12) %}
:
@@ -905,7 +905,7 @@
:
-
+
str
From dfd16379d0804fce1308b2b3f7d60d4ed7adae6a Mon Sep 17 00:00:00 2001
From: Dominic Davis-Foster
Date: Tue, 29 Apr 2025 09:49:10 +0100
Subject: [PATCH 17/33] Fix tests on newer Sphinx versions on newer Pythons.
---
.../test_html_output_overloads_html_.html | 26 +++++++++----------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/tests/test_output/test_output_/test_html_output_overloads_html_.html b/tests/test_output/test_output_/test_html_output_overloads_html_.html
index 255e148..52f3c74 100644
--- a/tests/test_output/test_output_/test_html_output_overloads_html_.html
+++ b/tests/test_output/test_output_/test_html_output_overloads_html_.html
@@ -205,7 +205,7 @@
:
-
+