mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-19 08:55:15 +00:00
94467e1a69
* Add package API documentation generation Add generation of the API documentation for akkudoktoreos and akkudoktoreosserver packages. The API documentation is generated by the Sphinx autosummary extension. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Enable Google style source commenting and documentation generation. Enable automatic documentation generation from Google style docstrings in the source. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Check Google style source commenting. Check Google style commenting by the appropriate ruff rules. Commenting is _NOT_ enforced. Missing docstrings are ignored. Minor commenting quirks of the code base are adapted. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Improve Markdown handling and switch to Markdown documentation. Switch to Markdown for the documentation files to improve the user and developer experience (see issue #181). Keep files with special directives for automatic API documentation in RST format. The directives expect RST. Also add dummy handling for openai/ swagger server documentation. The openai interface definition is for now taken from the fastapi PR as EOS will switch to fastAPI. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> --------- Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: Normann <github@koldrack.com>
10 lines
526 B
Markdown
10 lines
526 B
Markdown
% SPDX-License-Identifier: Apache-2.0
|
|
|
|
# About Akkudoktor EOS
|
|
|
|
The Energy System Simulation and Optimization System (EOS) provides a comprehensive solution for
|
|
simulating and optimizing an energy system based on renewable energy sources. With a focus on
|
|
photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements),
|
|
heat pumps, electric vehicles, and consideration of electricity price data, this system enables
|
|
forecasting and optimization of energy flow and costs over a specified period.
|