Skip to content

Commit 0763576

Browse files
mr-cbenjaoming
andauthored
support Python 3.11 with Sphinx 5.3+ (#1395)
* support Python 3.11 with Sphinx 5.3+ * Update tox.ini Co-authored-by: Michael R. Crusoe <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]>
1 parent f11e6c0 commit 0763576

File tree

4 files changed

+20
-4
lines changed

4 files changed

+20
-4
lines changed

.circleci/config.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,23 @@ jobs:
7979
steps:
8080
- run-tox:
8181
version: py310
82-
sphinx-version: "42,43,44,45,50,51,52,60,latest"
82+
sphinx-version: "42,43,44,45,50,51,52,53,60,latest"
83+
py311:
84+
docker:
85+
- image: 'cimg/python:3.11'
86+
steps:
87+
- run-tox:
88+
version: py311
89+
sphinx-version: "53,60,latest"
8390

8491
workflows:
8592
version: 2
8693
tests:
8794
jobs:
8895
- build
96+
- py311:
97+
requires:
98+
- build
8999
- py310:
90100
requires:
91101
- build

docs/changelog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Dependency Changes
1313
------------------
1414

1515
* docutils 0.18 is supported. (#1381)
16+
* Python 3.11 is officially supported and tested. (#1395)
17+
* Python 3.4 and 3.5 are officially not supported (#1395)
1618

1719
Note for users of Sphinx<3
1820
--------------------------

setup.cfg

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ classifiers =
3434
Programming Language :: Python :: 3.8
3535
Programming Language :: Python :: 3.9
3636
Programming Language :: Python :: 3.10
37+
Programming Language :: Python :: 3.11
3738
Operating System :: OS Independent
3839
Topic :: Documentation
3940
Topic :: Software Development :: Documentation
@@ -42,7 +43,7 @@ classifiers =
4243
include_package_data = True
4344
zip_safe = False
4445
packages = sphinx_rtd_theme
45-
python_requires = >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
46+
python_requires = >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*
4647
install_requires =
4748
sphinx >=1.6,<7
4849
docutils <0.19

tox.ini

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ envlist =
44
py{27}-sphinx{17,18}{-html4,-html5,}{-qa,}
55
py{36,37,38,39}-sphinx{17,18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,51,52}{-html4,-html5,}{-qa,}
66
# Python 3.10 working from Sphinx 4.2 and up
7-
py{310}-sphinx{42,43,44,45,50,51,52,latest}{-html4,-html5}{-qa,}
7+
py{310}-sphinx{42,43,44,45,50,51,52,53,latest}{-html4,-html5}{-qa,}
88
# Sphinx 6+ has simplified docutils and Python support
99
py{38,39,10}-sphinx{60}{-html5,}{-qa,}
10+
# Python 3.11 working from Sphinx 5.3 and up
11+
py{311}-sphinx{53,60,latest}{html5}{-qa,}
1012

1113
[testenv]
1214
setenv =
@@ -37,7 +39,8 @@ deps =
3739
sphinx50: Sphinx>=5.0,<5.1
3840
sphinx51: Sphinx>=5.1,<5.2
3941
sphinx52: Sphinx>=5.2,<5.3
40-
sphinx60: Sphinx==6.0.0
42+
sphinx53: Sphinx>=5.3,<5.4
43+
sphinx60: Sphinx>=6.0,<6.1
4144
# All these Sphinx versions actually break since docutils 0.18, so we need to add this upper bound
4245
# Projects using these Sphinx versions will have to do the same
4346
# See: https://github.com/readthedocs/sphinx_rtd_theme/pull/1304

0 commit comments

Comments
 (0)