Skip to content

Commit 0c46468

Browse files
committed
Prepare to host on readthedocs.org (#452)
1 parent b2b0bbe commit 0c46468

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
@@ -192,14 +192,16 @@ commands =
192192
[testenv:docs]
193193
deps =
194194
-c dev-requirements.txt
195+
-c docs-requirements.txt
195196
sphinx
196197
sphinx-rtd-theme
197198
sphinx-autodoc-typehints
198-
opentracing~=2.2.0
199-
Deprecated>=1.2.6
200-
thrift>=0.10.0
201-
pymongo ~= 3.1
202-
flask~=1.0
199+
# Required by ext packages
200+
opentracing
201+
Deprecated
202+
thrift
203+
pymongo
204+
flask
203205

204206
changedir = docs
205207

0 commit comments

Comments
 (0)