add tox env for docs

also, try to fix autodoc generation on readthedocs
jugmac00 · Apr 4, 2021 · e704e35 · e704e35
1 parent b23d9ec
commit e704e35
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ htmlcov/
 venv-wheel/
 venv-sdist/
 build/
+_build/
 dist/
 
 # ide

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -6,8 +6,9 @@ include *.toml
 include tox.ini
 recursive-include tests *.py
 
+recursive-include docs *.txt
 include docs/Makefile
 include docs/conf.py
 include docs/index.rst
 include docs/make.bat
-
+recursive-include src *.yaml
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx==3.5.3
+sphinx-rtd-theme==0.5.1
diff --git a/src/.readthedocs.yaml b/src/.readthedocs.yaml
@@ -0,0 +1,11 @@
+# File: .readthedocs.yaml
+
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  version: 3.8
+  install:
+    - requirements: docs/requirements.txt
diff --git a/tox.ini b/tox.ini
@@ -7,6 +7,7 @@ envlist =
     pre-commit,
     mypy,
     coverage,
+    docs,
 
 [testenv]
 extras = test
@@ -52,3 +53,10 @@ python =
     3.7: py37
     3.8: py38
     3.9: py39, pre-commit, mypy, coverage
+
+
+[testenv:docs]
+deps =
+    sphinx
+    sphinx_rtd_theme
+commands = sphinx-build -b html docs _build/html