docs: added auto-generation of documentation

ref: N25B-270
This commit is contained in:
Storm
2025-11-19 13:49:50 +01:00
parent b05aa5e834
commit 9dd39d2048
3 changed files with 31 additions and 1 deletions

View File

@@ -146,3 +146,25 @@ If your commit fails its either:
branch name != <type>/description-of-branch ,
commit name != <type>: description of the commit.
<ref>: N25B-Num's
## Documentation
Generate documentation web pages using:
```bash
PYTHONPATH=src sphinx-apidoc -F -o docs src/robot_interface
```
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
```