Skip to content

Commit b851ef6

Browse files
KSchopmeyerandy-maier
authored andcommitted
Fixes issue #1070, Sphinx fails python 2.7
1 parent 7aac327 commit b851ef6

File tree

4 files changed

+24
-3
lines changed

4 files changed

+24
-3
lines changed

dev-requirements.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,15 @@ PyYAML>=5.2,<5.3; python_version == '3.4'
6363
PyYAML>=5.3.1; python_version > '3.4'
6464

6565
# Sphinx (no imports, invoked via sphinx-build script):
66-
Sphinx>=1.7.6
66+
# Keep in sync with rtd-requirements.txt
67+
# Sphinx 2.0.0 removed support for Python 2.7 and 3.4
68+
# Sphinx 4.0.0 breaks autodocsumm (issue #2697)
69+
# Sphinx 3.5.4 started including test for docutils version < 0.17 for 3.5.4
70+
# and < 0.18 for sphinx 4.
71+
Sphinx>=1.7.6,<2.0.0; python_version <= '3.4'
72+
Sphinx>=3.5.4,!=4.0.0; python_version >= '3.5'
73+
# Issue pwybem #2787 docutils v=0.18/Sphinx incompatibility
74+
docutils<0.18; python_version <= '3.4'
6775
sphinx-git>=10.1.1
6876
GitPython>=2.1.1;
6977
sphinxcontrib-fulltoc>=1.2.0

docs/changes.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ Released: not yet
3939
* Fixed install error of wrapt 1.13.0 on Python 2.7 on Windows due to lack of
4040
MS Visual C++ 9.0 on GitHub Actions, by pinning it to <1.13.
4141

42+
* Fixed issue with Sphinx and python 2.7 by changing the sphinx requirements
43+
in dev-requirements.txt and minimum-constraints.txt. (see issue #1070)
44+
4245
**Enhancements:**
4346

4447
* Enhanced test matrix for push-driven runs on GitHub Actions to add

minimum-constraints.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ dparse>=0.5.1; python_version >= '3.5'
9494
tox==2.0.0
9595

9696
# Sphinx (no imports, invoked via sphinx-build script):
97-
Sphinx==1.7.6
97+
Sphinx==1.7.6; python_version <= '3.4'
98+
Sphinx==3.5.4; python_version >= '3.5'
9899
sphinx-git==10.1.1
99100
GitPython==2.1.1
100101
sphinxcontrib-fulltoc==1.2.0

rtd-requirements.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ six>=1.14.0
55
ply>=3.10
66
PyYAML>=3.13
77
# M2Crypto>=0.30.1 # we cannot install M2Crypto because RTD does not have Swig
8-
Sphinx>=1.7.6
8+
# Sphinx (no imports, invoked via sphinx-build script):
9+
# Keep in sync with rtd-requirements.txt
10+
# Sphinx 2.0.0 removed support for Python 2.7 and 3.4
11+
# Sphinx 4.0.0 breaks autodocsumm (issue #2697)
12+
# Sphinx 3.5.4 started including test for docutils version
13+
Sphinx>=1.7.6,<2.0.0; python_version <= '3.4'
14+
Sphinx>=3.5.4,!=4.0.0; python_version >= '3.5'
15+
# Issue pwybem #2787 docutils v=0.18/Sphinx incompatibility
16+
# Until Sphinx 4.3.0 is released.
17+
docutils<0.18; python_version <= '3.4'
918
sphinx-git>=10.1.1
1019
sphinxcontrib-fulltoc>=1.2.0

0 commit comments

Comments
 (0)