Skip to content

Commit 76f2d0b

Browse files
committed
fix(readthedocs): install CLI requirements explicitly
Readthedocs.org began failing to generate our Python code autodocs recently. Purging the build environment (use https://readthedocs.org/wipe/deis/latest/) did not help. Their logs indicate Sphinx is confused by a version of the urllib3 library that happens to be installed in the system python. This packaging error was fixed in urllib3 1.8.2, see https://pypi.python.org/pypi/urllib3. This adds the client's requirements explicitly to the docs_requirements.txt so that this broken version of urllib3 isn't used. This is also fixed by requests 2.3.0, but pinning urllib3 seemed like a safer fix.
1 parent 82c2a0d commit 76f2d0b

3 files changed

Lines changed: 6 additions & 1 deletion

File tree

client/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
long_description=LONG_DESCRIPTION,
5959
install_requires=[
6060
'docopt==0.6.1', 'python-dateutil==2.2',
61-
'PyYAML==3.10', 'requests==2.2.1'
61+
'PyYAML==3.10', 'requests==2.2.1', 'urllib3==1.8.2'
6262
],
6363
zip_safe=True,
6464
**KWARGS)

controller/dev_requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ docopt==0.6.1
33
python-dateutil==2.2
44
#PyYAML==3.10
55
requests==2.2.1
6+
urllib3==1.8.2
67

78
# PyInstaller builds client binaries
89
PyInstaller==2.1

docs/docs_requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ South==0.8.4
2424

2525
# Deis client requirements
2626
docopt==0.6.1
27+
python-dateutil==2.2
28+
#PyYAML==3.10
29+
requests==2.2.1
30+
urllib3==1.8.2
2731

2832
# Deis documentation requirements
2933
Sphinx>=1.2.2

0 commit comments

Comments
 (0)