From 6cb1450a6712d7883f68f64ad4346166e7481e96 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 10 Sep 2023 02:21:15 +0100 Subject: [PATCH 1/5] Bump minimum Sphinx version to 3.5 --- Doc/conf.py | 2 +- Doc/requirements-oldest-sphinx.txt | 10 +++++----- .../2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst | 1 + 3 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst diff --git a/Doc/conf.py b/Doc/conf.py index 16fd8bf257179e..e58f58bd507236 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -66,7 +66,7 @@ highlight_language = 'python3' # Minimum version of sphinx required -needs_sphinx = '3.2' +needs_sphinx = '3.5' # Ignore any .rst files in the includes/ directory; # they're embedded in pages but not rendered individually. diff --git a/Doc/requirements-oldest-sphinx.txt b/Doc/requirements-oldest-sphinx.txt index 94611ca22f09fe..4d1b3d1547880a 100644 --- a/Doc/requirements-oldest-sphinx.txt +++ b/Doc/requirements-oldest-sphinx.txt @@ -7,12 +7,12 @@ blurb python-docs-theme>=2022.1 # Generated from: -# pip install "Sphinx~=3.2.0" "docutils<0.17" "Jinja2<3" "MarkupSafe<2" +# pip install "Sphinx~=3.5.0" "docutils<0.17" "Jinja2<3" "MarkupSafe<2" # pip freeze # -# Sphinx 3.2 comes from ``needs_sphinx = '3.2'`` in ``Doc/conf.py``. +# Sphinx 3.5 comes from ``needs_sphinx = '3.5'`` in ``Doc/conf.py``. # Docutils<0.17, Jinja2<3, and MarkupSafe<2 are additionally specified as -# Sphinx 3.2 is incompatible with newer releases of these packages. +# Sphinx 3.5 is incompatible with newer releases of these packages. alabaster==0.7.13 Babel==2.12.1 @@ -25,10 +25,10 @@ imagesize==1.4.1 Jinja2==2.11.3 MarkupSafe==1.1.1 packaging==23.1 -Pygments==2.15.1 +Pygments==2.16.1 requests==2.31.0 snowballstemmer==2.2.0 -Sphinx==3.2.1 +Sphinx==3.5.4 sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1 diff --git a/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst b/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst new file mode 100644 index 00000000000000..d84798c20e6567 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst @@ -0,0 +1 @@ +The minimum Sphinx version required for the documentation is now 3.5. From 2c23f4c8bdab4bf0b0114a6c7e76dcf12c025988 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 10 Sep 2023 03:00:12 +0100 Subject: [PATCH 2/5] Specify PYTHON --- .github/workflows/reusable-docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/reusable-docs.yml b/.github/workflows/reusable-docs.yml index 51efa54e8d1b3d..44015d89be24c5 100644 --- a/.github/workflows/reusable-docs.yml +++ b/.github/workflows/reusable-docs.yml @@ -74,13 +74,13 @@ jobs: - name: 'Set up Python' uses: actions/setup-python@v4 with: - python-version: '3.11' # known to work with Sphinx 3.2 + python-version: '3.11' # known to work with Sphinx 3.5 cache: 'pip' cache-dependency-path: 'Doc/requirements-oldest-sphinx.txt' - name: 'Install build dependencies' run: make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt" - name: 'Build HTML documentation' - run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html + run: make -C Doc/ PYTHON=venv/bin/python3 SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html # Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release doctest: From 29a3f36f28cf64b3ce795e3e65aa1845e80de3e9 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 10 Sep 2023 03:01:54 +0100 Subject: [PATCH 3/5] Path --- .github/workflows/reusable-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-docs.yml b/.github/workflows/reusable-docs.yml index 44015d89be24c5..19d27936937a1b 100644 --- a/.github/workflows/reusable-docs.yml +++ b/.github/workflows/reusable-docs.yml @@ -80,7 +80,7 @@ jobs: - name: 'Install build dependencies' run: make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt" - name: 'Build HTML documentation' - run: make -C Doc/ PYTHON=venv/bin/python3 SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html + run: make -C Doc/ PYTHON=Doc/venv/bin/python3 SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html # Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release doctest: From 2b8e32c25701ec9f636dc575eb2723ad5ba600ce Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 10 Sep 2023 03:04:11 +0100 Subject: [PATCH 4/5] Try PYTHON=../python --- .github/workflows/reusable-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-docs.yml b/.github/workflows/reusable-docs.yml index 19d27936937a1b..9b2cabf96127ff 100644 --- a/.github/workflows/reusable-docs.yml +++ b/.github/workflows/reusable-docs.yml @@ -80,7 +80,7 @@ jobs: - name: 'Install build dependencies' run: make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt" - name: 'Build HTML documentation' - run: make -C Doc/ PYTHON=Doc/venv/bin/python3 SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html + run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html # Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release doctest: From ba2e02e13155c9638bb686aafdbef829069af295 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 10 Sep 2023 03:25:07 +0100 Subject: [PATCH 5/5] Bump to 4.2 --- .github/workflows/reusable-docs.yml | 4 ++-- Doc/conf.py | 2 +- Doc/requirements-oldest-sphinx.txt | 8 +++----- .../2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst | 2 +- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/workflows/reusable-docs.yml b/.github/workflows/reusable-docs.yml index 9b2cabf96127ff..1c4fa4239c1e34 100644 --- a/.github/workflows/reusable-docs.yml +++ b/.github/workflows/reusable-docs.yml @@ -74,13 +74,13 @@ jobs: - name: 'Set up Python' uses: actions/setup-python@v4 with: - python-version: '3.11' # known to work with Sphinx 3.5 + python-version: '3.11' # known to work with Sphinx 4.2 cache: 'pip' cache-dependency-path: 'Doc/requirements-oldest-sphinx.txt' - name: 'Install build dependencies' run: make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt" - name: 'Build HTML documentation' - run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html + run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html # Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release doctest: diff --git a/Doc/conf.py b/Doc/conf.py index e58f58bd507236..c92ea60ee07094 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -66,7 +66,7 @@ highlight_language = 'python3' # Minimum version of sphinx required -needs_sphinx = '3.5' +needs_sphinx = '4.2' # Ignore any .rst files in the includes/ directory; # they're embedded in pages but not rendered individually. diff --git a/Doc/requirements-oldest-sphinx.txt b/Doc/requirements-oldest-sphinx.txt index 4d1b3d1547880a..d3ef5bc17650ae 100644 --- a/Doc/requirements-oldest-sphinx.txt +++ b/Doc/requirements-oldest-sphinx.txt @@ -7,12 +7,10 @@ blurb python-docs-theme>=2022.1 # Generated from: -# pip install "Sphinx~=3.5.0" "docutils<0.17" "Jinja2<3" "MarkupSafe<2" +# pip install "Sphinx~=4.2.0" # pip freeze # -# Sphinx 3.5 comes from ``needs_sphinx = '3.5'`` in ``Doc/conf.py``. -# Docutils<0.17, Jinja2<3, and MarkupSafe<2 are additionally specified as -# Sphinx 3.5 is incompatible with newer releases of these packages. +# Sphinx 4.2 comes from ``needs_sphinx = '4.2'`` in ``Doc/conf.py``. alabaster==0.7.13 Babel==2.12.1 @@ -28,7 +26,7 @@ packaging==23.1 Pygments==2.16.1 requests==2.31.0 snowballstemmer==2.2.0 -Sphinx==3.5.4 +Sphinx==4.2.0 sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1 diff --git a/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst b/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst index d84798c20e6567..79cc0b72ec742f 100644 --- a/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst +++ b/Misc/NEWS.d/next/Documentation/2023-09-10-02-39-06.gh-issue-109209.0LBewo.rst @@ -1 +1 @@ -The minimum Sphinx version required for the documentation is now 3.5. +The minimum Sphinx version required for the documentation is now 4.2.