Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare to host on readthedocs.org #452

Merged
merged 7 commits into from
Mar 2, 2020
Merged

Prepare to host on readthedocs.org #452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
16ec59a
Add .readthedocs.yml
c24t Feb 28, 2020
6ccd47f
Split out docs requirements
c24t Feb 28, 2020
7c24fd8
Remove docs requirements versions
c24t Feb 28, 2020
31a8f41
Use explicit deps with constraints in tox
c24t Feb 28, 2020
4af9826
Stick to known good sphinx and etc. versions
c24t Feb 28, 2020
3e7a9e9
Bump sphinx version
c24t Feb 28, 2020
77902af
Add ext docs requirements
c24t Mar 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
10 changes: 10 additions & 0 deletions docs-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
12 changes: 7 additions & 5 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down