docs: added auto-generation of documentation

ref: N25B-270
This commit is contained in:
Storm
2025-11-19 13:44:08 +01:00
parent df1e891a22
commit 7e73baf8be
3 changed files with 180 additions and 0 deletions

View File

@@ -63,3 +63,25 @@ git config --local --unset core.hooksPath
```
Then run the pre-commit install commands again.
## Documentation
Generate documentation web pages using:
```bash
PYTHONPATH=src sphinx-apidoc -F -o docs src/control_backend
```
Optionally, in the `conf.py` file in the new `docs` folder, change preferences.
For the page theme, change `html_theme` to `'sphinx_rtd_theme'`.
In the `docs` folder:
### Windows
```bash
.\make.bat html
```
### MacOS
```bash
make html
```