EOS/docs/akkudoktoreos/serverapi.md

% SPDX-License-Identifier: Apache-2.0

# Server API

```{include} /_generated/openapi.md
:start-line: 2
:relative-docs: ..
:relative-images:
```
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> 2025-01-03 00:31:20 +01:00			`% SPDX-License-Identifier: Apache-2.0`

			`# Server API`

Adapt documentation generation to be compliant to ReadTheDocs and Windows. (#341) Use documentation generation tools that are available for Windows and Linux. Use python instead of shell scripts to generate documentation. For ReadTheDocs make generated documentation content static to avoid running scripts outside of the docs/ path which is the default path for ReadTheDOcs. Add tests that check if generated content does go out of sync with latest source. Use tabs to show commands for Windows and Linux to improve user experience. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> 2025-01-06 16:27:57 +01:00			```{include} /_generated/openapi.md
			`:start-line: 2`
			`:relative-docs: ..`
			`:relative-images:`
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> 2025-01-03 00:31:20 +01:00			```