]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
docs: Use python 3.7 via conda for readthedocs builds
authorBen Darnell <ben@bendarnell.com>
Sun, 30 Dec 2018 00:57:39 +0000 (19:57 -0500)
committerBen Darnell <ben@bendarnell.com>
Sun, 30 Dec 2018 00:57:39 +0000 (19:57 -0500)
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
https://github.com/rtfd/readthedocs-docker-images/pull/73

docs/conda.yml [new file with mode: 0644]
readthedocs.yml [new file with mode: 0644]

diff --git a/docs/conda.yml b/docs/conda.yml
new file mode 100644 (file)
index 0000000..e33288d
--- /dev/null
@@ -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
diff --git a/readthedocs.yml b/readthedocs.yml
new file mode 100644 (file)
index 0000000..e403820
--- /dev/null
@@ -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