Initial readthedocs config

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+   configuration: docs/conf.py
+
+python:
+   install:
+   - requirements: requirements-dev.txt

CONTRIBUTING.md

@@ -4,6 +4,10 @@ Thanks for taking the time to read this!
 
 The `EOS` project is in early development, therefore we encourage contribution in the following ways:
 
+## Documentation
+
+Latest development documentation can be found at [Akkudoktor-EOS](https://akkudoktor-eos.readthedocs.io/en/main/).
+
 ## Bug Reports
 
 Please report flaws or vulnerabilities in the [GitHub Issue Tracker](https://github.com/Akkudoktor-EOS/EOS/issues) using the corresponding issue template.

Makefile

@@ -54,6 +54,7 @@ dist: pip
 
 # Target to generate documentation
 gen-docs: pip-dev
+	.venv/bin/pip install -e .
 	.venv/bin/python ./scripts/generate_config_md.py --output-file docs/_generated/config.md
 	.venv/bin/python ./scripts/generate_openapi_md.py --output-file docs/_generated/openapi.md
 	.venv/bin/python ./scripts/generate_openapi.py --output-file openapi.json

README.md

@@ -2,6 +2,8 @@
 
 This project 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.
 
+Documentation can be found at [Akkudoktor-EOS](https://akkudoktor-eos.readthedocs.io/en/latest/).
+
 ## Getting Involved
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).