Prepare to host on readthedocs.org (#452)

open-telemetry · Mar 2, 2020 · 344d72b · 344d72b
1 parent 11467c4
commit 344d72b
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 5 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  image: latest
+
+python:
+  version: 3.8
+  install:
+    - requirements: docs-requirements.txt
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -0,0 +1,10 @@
+sphinx~=2.4
+sphinx-rtd-theme~=0.4
+sphinx-autodoc-typehints~=1.10.2
+
+# Required by ext packages
+opentracing~=2.2.0
+Deprecated>=1.2.6
+thrift>=0.10.0
+pymongo~=3.1
+flask~=1.0
diff --git a/tox.ini b/tox.ini
@@ -197,14 +197,16 @@ commands =
 [testenv:docs]
 deps =
   -c dev-requirements.txt
+  -c docs-requirements.txt
   sphinx
   sphinx-rtd-theme
   sphinx-autodoc-typehints
-  opentracing~=2.2.0
-  Deprecated>=1.2.6
-  thrift>=0.10.0
-  pymongo ~= 3.1
-  flask~=1.0
+  # Required by ext packages
+  opentracing
+  Deprecated
+  thrift
+  pymongo
+  flask
 
 changedir = docs