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