From: Benjamin Braatz <benjamin.braatz@graph-it.com>
Date: Wed, 17 Mar 2021 14:43:52 +0000 (+0100)
Subject: Add pdoc3 to setup.py and index.md.
X-Git-Tag: v0.3.0~56
X-Git-Url: http://git.graph-it.com/?a=commitdiff_plain;h=bfa513d945abea341613c8d60a129c8f3dfce86c;p=graphit%2Fcontrolpi.git

Add pdoc3 to setup.py and index.md.
---

diff --git a/doc/index.md b/doc/index.md
index 5baba4c..0a5cf05 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -85,6 +85,13 @@ des Codes mit Tests erhält man mit der zusätzlichen Option `-v`:
 (venv)$ python -m doctest -v <Pfad zur Code-Datei>
 ```
 
+Außerdem wird durch die `[dev]`-Extras in `setup.py` auch das Tool `pdoc`
+zur automatischen Generierung von API-Dokumentation in HTML installiert:
+```sh
+(venv)$ pdoc --html --config sort_identifiers=False --force \
+             --output-dir doc/ controlpi/ controlpi-plugins/
+```
+
 ## Überblick
 Die ControlPi-Infrastruktur hat zwei Haupt-Bestandteile:
 - Ein Plugin-System erlaubt es, ohne Anpassungen am Code der Infrastruktur
diff --git a/setup.py b/setup.py
index 4adccf6..78a75ac 100644
--- a/setup.py
+++ b/setup.py
@@ -23,6 +23,7 @@ setuptools.setup(
             "pycodestyle",
             "pydocstyle",
             "mypy",
+            "pdoc3",
         ]
     },
     classifiers=[