docs: added auto-generation of documentation #10

Merged
s.o.h.luijkx merged 4 commits from docs/gen_documentation into dev 2025-11-19 17:14:36 +00:00
Showing only changes of commit a0a8ad2689 - Show all commits

View File

@@ -150,21 +150,26 @@ commit name != <type>: description of the commit.
## Documentation
Generate documentation web pages using:
### Linux & macOS
```bash
PYTHONPATH=src sphinx-apidoc -F -o docs src/robot_interface
```
### Windows
```bash
$env: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:
### Linux & macOS
```bash
make html
```
### Windows
```bash
.\make.bat html
```
### MacOS
```bash
make html
```