Skip to content

Commit

Permalink
docs: Use python 3.7 via conda for readthedocs builds
Browse files Browse the repository at this point in the history
The typing module in python 3.5 has problems with some type
annotations so we need to build with 3.7. RTD doesn't yet support py37
natively but we can get it with conda following an example at
readthedocs/readthedocs-docker-images#73
  • Loading branch information
bdarnell committed Dec 30, 2018
1 parent cb2d897 commit e7e31e5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/conda.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# TODO: remove when RTD supports python 3.7 without conda
name: tornado-docs
dependencies:
- python=3.7
- pip:
- sphinx
- sphinx-rtd-theme
- Twisted
4 changes: 4 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# TODO: remove when RTD supports Python 3.7 without conda.
# https://github.com/rtfd/readthedocs-docker-images/pull/73
conda:
file: docs/conda.yml

0 comments on commit e7e31e5

Please sign in to comment.