Skip to content

Commit 344d72b

Browse files
authored
Prepare to host on readthedocs.org (#452)
1 parent 11467c4 commit 344d72b

File tree

3 files changed

+31
-5
lines changed

3 files changed

+31
-5
lines changed

.readthedocs.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
version: 2
4+
5+
sphinx:
6+
configuration: docs/conf.py
7+
8+
build:
9+
image: latest
10+
11+
python:
12+
version: 3.8
13+
install:
14+
- requirements: docs-requirements.txt

docs-requirements.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
sphinx~=2.4
2+
sphinx-rtd-theme~=0.4
3+
sphinx-autodoc-typehints~=1.10.2
4+
5+
# Required by ext packages
6+
opentracing~=2.2.0
7+
Deprecated>=1.2.6
8+
thrift>=0.10.0
9+
pymongo~=3.1
10+
flask~=1.0

tox.ini

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -197,14 +197,16 @@ commands =
197197
[testenv:docs]
198198
deps =
199199
-c dev-requirements.txt
200+
-c docs-requirements.txt
200201
sphinx
201202
sphinx-rtd-theme
202203
sphinx-autodoc-typehints
203-
opentracing~=2.2.0
204-
Deprecated>=1.2.6
205-
thrift>=0.10.0
206-
pymongo ~= 3.1
207-
flask~=1.0
204+
# Required by ext packages
205+
opentracing
206+
Deprecated
207+
thrift
208+
pymongo
209+
flask
208210

209211
changedir = docs
210212

0 commit comments

Comments
 (0)