Skip to content

Commit 2c9c441

Browse files
committed
DOC: require Sphinx >= 1.5.1
Older versions of Sphinx are incompatible with newer versions of docutils. It is still possible to install nbsphinx on old systems, as long as docutils is also old. The Travis-CI settings were adapted to install old docutils when testing old Sphinx. The ban of Sphinx 1.5.0 was removed from setup.py. This wasn't quite correct anyway, since all versions below 1.5.1 are affected by the docutils incompatibility.
1 parent 1a2001c commit 2c9c441

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

.travis.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ matrix:
88
- env: ADDITIONAL_COMMAND="python -m sphinx doc/ doc/_build/ -b linkcheck"
99

1010
# a few older Sphinx releases using default Python version
11-
- env: SPHINX="==1.3.2"
12-
- env: SPHINX="==1.3.6"
13-
- env: SPHINX="==1.4.9"
11+
- env: SPHINX="==1.3.2 docutils<0.13.1"
12+
- env: SPHINX="==1.3.6 docutils<0.13.1"
13+
- env: SPHINX="==1.4.9 docutils<0.13.1"
14+
- env: SPHINX="==1.5.0 docutils<0.13.1"
1415
- env: SPHINX="==1.5.1"
1516
- env: SPHINX="==1.5.3"
1617
- env: SPHINX="==1.5.6"
@@ -28,7 +29,7 @@ addons:
2829
install:
2930
- pip install Sphinx$SPHINX
3031
- pip install .
31-
- pip install -r doc/requirements.txt
32+
- pip install ipykernel
3233
script:
3334
- python -m sphinx doc/ doc/_build/ -b html
3435
- python -m sphinx doc/ doc/_build/ -b latex

doc/readthedocs-environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ channels:
22
- conda-forge
33
dependencies:
44
- python==3.5
5-
- sphinx>=1.4
5+
- sphinx>=1.5.1
66
- pandoc
77
- nbconvert
88
- ipykernel

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
sphinx>=1.4
1+
sphinx>=1.5.1
22
nbsphinx
33
ipykernel

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
'nbconvert',
1919
'traitlets',
2020
'nbformat',
21-
'sphinx>=1.3.2,!=1.5.0',
21+
'sphinx>=1.3.2',
2222
],
2323
author='Matthias Geier',
2424
author_email='[email protected]',

0 commit comments

Comments
 (0)