aboutsummaryrefslogtreecommitdiff
path: root/tox.ini
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2022-12-29 16:20:18 +0100
committerDaniel Schadt <kingdread@gmx.de>2022-12-29 16:20:18 +0100
commit28d44ca764955cb042e5d1821ffc23e2b9aba07c (patch)
tree2aa45eb096dca2a18baf0b43a3a0deabfbdea88f /tox.ini
parent75368c69f45b2995e1adcd58795f5c33fbf5b9b3 (diff)
downloadfietsboek-28d44ca764955cb042e5d1821ffc23e2b9aba07c.tar.gz
fietsboek-28d44ca764955cb042e5d1821ffc23e2b9aba07c.tar.bz2
fietsboek-28d44ca764955cb042e5d1821ffc23e2b9aba07c.zip
generate & build API docs for the Python package
We have so many nice docstrings, but they aren't really rendered anywhere (expect locally in your IDE), as we did not include the API docs anywhere. This change uses sphinx-apidoc to generate autodoc stubs for Sphinx, so that the docstrings are actually rendered to HTML. This is not perfect yet (I'm not too happy about the default modules.rst simply listing one package), but it is good enough for the start and makes it possible to actually browse the docstrings in a browser.
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini1
1 files changed, 1 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini
index a31e865..86909c4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -49,6 +49,7 @@ changedir={toxinidir}{/}doc
commands_pre =
poetry install -v --with docs
commands =
+ sphinx-apidoc -d 1 -f -M -e -o developer/module/ ../fietsboek "upd_*"
make html
[testenv:mypy]