Skip to content

Commit e918b19

Browse files
[3.11] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (#109637)
GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (cherry picked from commit 712cb17) Co-authored-by: Adam Turner <[email protected]>
1 parent 9414ddf commit e918b19

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

.github/workflows/reusable-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
- name: 'Set up Python'
4545
uses: actions/setup-python@v4
4646
with:
47-
python-version: '3.11' # known to work with Sphinx 3.2
47+
python-version: '3.11' # known to work with Sphinx 4.2
4848
cache: 'pip'
4949
cache-dependency-path: 'Doc/requirements-oldest-sphinx.txt'
5050
- name: 'Install build dependencies'

Doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
highlight_language = 'python3'
6262

6363
# Minimum version of sphinx required
64-
needs_sphinx = '3.2'
64+
needs_sphinx = '4.2'
6565

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

Doc/requirements-oldest-sphinx.txt

Lines changed: 4 additions & 6 deletions
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
Lines changed: 1 addition & 0 deletions
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)