Skip to content

Commit 712cb17

Browse files
authored
pythonGH-109209: Bump the minimum Sphinx version to 4.2 (python#109210)
1 parent 9ccf054 commit 712cb17

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

.github/workflows/reusable-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ jobs:
7474
- name: 'Set up Python'
7575
uses: actions/setup-python@v4
7676
with:
77-
python-version: '3.11' # known to work with Sphinx 3.2
77+
python-version: '3.11' # known to work with Sphinx 4.2
7878
cache: 'pip'
7979
cache-dependency-path: 'Doc/requirements-oldest-sphinx.txt'
8080
- name: 'Install build dependencies'

Doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
highlight_language = 'python3'
6767

6868
# Minimum version of sphinx required
69-
needs_sphinx = '3.2'
69+
needs_sphinx = '4.2'
7070

7171
# Ignore any .rst files in the includes/ directory;
7272
# they're embedded in pages but not rendered individually.

Doc/requirements-oldest-sphinx.txt

+4-6
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ blurb
77
python-docs-theme>=2022.1
88

99
# Generated from:
10-
# pip install "Sphinx~=3.2.0" "docutils<0.17" "Jinja2<3" "MarkupSafe<2"
10+
# pip install "Sphinx~=4.2.0"
1111
# pip freeze
1212
#
13-
# Sphinx 3.2 comes from ``needs_sphinx = '3.2'`` in ``Doc/conf.py``.
14-
# Docutils<0.17, Jinja2<3, and MarkupSafe<2 are additionally specified as
15-
# Sphinx 3.2 is incompatible with newer releases of these packages.
13+
# Sphinx 4.2 comes from ``needs_sphinx = '4.2'`` in ``Doc/conf.py``.
1614

1715
alabaster==0.7.13
1816
Babel==2.12.1
@@ -25,10 +23,10 @@ imagesize==1.4.1
2523
Jinja2==2.11.3
2624
MarkupSafe==1.1.1
2725
packaging==23.1
28-
Pygments==2.15.1
26+
Pygments==2.16.1
2927
requests==2.31.0
3028
snowballstemmer==2.2.0
31-
Sphinx==3.2.1
29+
Sphinx==4.2.0
3230
sphinxcontrib-applehelp==1.0.4
3331
sphinxcontrib-devhelp==1.0.2
3432
sphinxcontrib-htmlhelp==2.0.1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The minimum Sphinx version required for the documentation is now 4.2.

0 commit comments

Comments
 (0)