docs: added auto-generation of documentation
ref: N25B-270
This commit is contained in:
22
README.md
22
README.md
@@ -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
|
||||
```
|
||||
Reference in New Issue
Block a user