From e704e355eba33d5a5563af724acd126cb3d5a034 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Sun, 4 Apr 2021 16:25:14 +0200 Subject: [PATCH] add tox env for docs also, try to fix autodoc generation on readthedocs --- .gitignore | 1 + MANIFEST.in | 3 ++- docs/requirements.txt | 2 ++ src/.readthedocs.yaml | 11 +++++++++++ tox.ini | 8 ++++++++ 5 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/requirements.txt create mode 100644 src/.readthedocs.yaml diff --git a/.gitignore b/.gitignore index 7fb04d4..574425c 100644 --- 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 index b8b6683..f8ba221 100644 --- 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 new file mode 100644 index 0000000..f588e8c --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx==3.5.3 +sphinx-rtd-theme==0.5.1 \ No newline at end of file diff --git a/src/.readthedocs.yaml b/src/.readthedocs.yaml new file mode 100644 index 0000000..531507f --- /dev/null +++ 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 \ No newline at end of file diff --git a/tox.ini b/tox.ini index 2e68acd..e7b02e9 100644 --- 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