mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-08-25 23:11:14 +00:00
Add documentation. (#321)
Add documentation that covers: - Prediction - Measuremnt - REST API Add Python scripts that support automatic documentation generation using the Sphinx sphinxcontrib.eval extension. Add automatic update/ test for REST API documentation. Filter proxy endpoints from REST API documentation. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
This commit is contained in:
3
docs/develop/CONTRIBUTING.md
Normal file
3
docs/develop/CONTRIBUTING.md
Normal file
@@ -0,0 +1,3 @@
|
||||
```{eval-sh}
|
||||
./scripts/extract_markdown.py --input-file CONTRIBUTING.md
|
||||
```
|
5
docs/develop/getting_started.md
Normal file
5
docs/develop/getting_started.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Getting Started
|
||||
|
||||
```{eval-sh}
|
||||
./scripts/extract_markdown.py --input-file README.md --start-line "## Getting Involved"
|
||||
```
|
Reference in New Issue
Block a user