docs: conf.py is now included, sphinx is properly installed using uv

ref: N25B-270
This commit is contained in:
Storm
2025-11-19 17:47:10 +01:00
parent 7e73baf8be
commit 8c209d3adb
5 changed files with 55 additions and 12 deletions

View File

@@ -67,21 +67,26 @@ Then run the pre-commit install commands again.
## Documentation
Generate documentation web pages using:
### Linux & macOS
```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'`.
### Windows
```bash
$env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/control_backend
```
Optionally, in the `conf.py` file in the `docs` folder, change preferences.
In the `docs` folder:
### Linux & macOS
```bash
make html
```
### Windows
```bash
.\make.bat html
```
### MacOS
```bash
make html
```