pepperplus/pepperplus-ri
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: changed readme

Browse Source 
ref: N25B-270
This commit is contained in:
Storm
2025-11-19 17:59:37 +01:00
parent 1c9467d03a
commit a0a8ad2689
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

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