From ef4e245804759d44ae54fc832b4d5155837f0720 Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Tue, 17 Jan 2023 17:36:52 +0000 Subject: [PATCH 1/6] Add Sphinx 6.1.3 to test matrix But don't test it against 3.7 as it does not support that release. --- .github/workflows/unit_tests.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index 919d4450..7a797984 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -17,6 +17,7 @@ jobs: - '5.0.2' - '5.1.1' - '5.3.0' + - '6.1.3' - git+https://github.com/sphinx-doc/sphinx.git@master exclude: # avoid bug in following configurations @@ -27,9 +28,12 @@ jobs: sphinx-version: '4.0.3' - python-version: '3.10' sphinx-version: '4.1.2' + # Sphinx has removed support for Python 3.7, Breathe will follow. - python-version: '3.7' sphinx-version: git+https://github.com/sphinx-doc/sphinx.git@master + - python-version: '3.7' + sphinx-version: '6.1.3' steps: - uses: actions/checkout@v2 From 00b29e83541c2f4b16b1c0bd4d1abfb0c2a31834 Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Tue, 17 Jan 2023 17:43:55 +0000 Subject: [PATCH 2/6] Adjust constraint setup.py So that we accept Sphinx 6. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index fb7f73b0..0e3d58ce 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ render `Doxygen `__ xml output. """ -requires = ["Sphinx>=4.0,<6,!=5.0.0", "docutils>=0.12"] +requires = ["Sphinx>=4.0,<7,!=5.0.0", "docutils>=0.12"] if sys.version_info < (3, 7): print("ERROR: Sphinx requires at least Python 3.7 to run.") From 687a3278e894b461df3ea00d6c6b2da140757728 Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Tue, 17 Jan 2023 17:52:35 +0000 Subject: [PATCH 3/6] Adjust constraint in production requirements.txt --- requirements/production.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/production.txt b/requirements/production.txt index 688298a3..a0e48e11 100644 --- a/requirements/production.txt +++ b/requirements/production.txt @@ -2,4 +2,4 @@ docutils>=0.12 Jinja2>=2.7.3 MarkupSafe>=0.23 Pygments>=1.6 -Sphinx>=4.0,<6,!=5.0.0 +Sphinx>=4.0,<7,!=5.0.0 From 81a92d8ea06fe4dd43cea85282b1ad092e58c3c4 Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Tue, 17 Jan 2023 18:09:30 +0000 Subject: [PATCH 4/6] Update changelog with latest changes I'm afraid I'm blurry on where the sort option applies and don't quite have the energy to investigate properly. --- CHANGELOG.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1c40dd0d..349fce8e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -11,6 +11,10 @@ Inspired by `Keepachangelog.com `__. `#865 `__ - Bump Python requirement to 3.7. `#866 `__ + - Support Sphinx 6. + `#885 `__ + - Support ``:sort:`` option to sort sections by name. + `#879 `__ - 2022-06-20 - **Breathe v4.34.0** From 86298ccf2fd8ead0867a2ac74ac894a9ef25bb67 Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Wed, 18 Jan 2023 19:32:26 +0000 Subject: [PATCH 5/6] Remove <7 constraint from requirement file As we're expecting Sphinx to have more major version changes in the near future and this will make things smoother. Co-authored-by: Jakob Lykke Andersen --- requirements/production.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/production.txt b/requirements/production.txt index a0e48e11..816dbe45 100644 --- a/requirements/production.txt +++ b/requirements/production.txt @@ -2,4 +2,4 @@ docutils>=0.12 Jinja2>=2.7.3 MarkupSafe>=0.23 Pygments>=1.6 -Sphinx>=4.0,<7,!=5.0.0 +Sphinx>=4.0,!=5.0.0 From 42585399bf666b0c673b222291c4886700ec283e Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Wed, 18 Jan 2023 19:33:46 +0000 Subject: [PATCH 6/6] Remove <7 constraint from setup.py Same reasoning as the last commit. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 0e3d58ce..1ca127eb 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ render `Doxygen `__ xml output. """ -requires = ["Sphinx>=4.0,<7,!=5.0.0", "docutils>=0.12"] +requires = ["Sphinx>=4.0,!=5.0.0", "docutils>=0.12"] if sys.version_info < (3, 7): print("ERROR: Sphinx requires at least Python 3.7 to run.")