Initial readthedocs config

.readthedocs.yaml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+  jobs:
+    post_install:
+      # Install package so the auto generation in eval-sh can access package imports
+      - pip install -e .
+
+sphinx:
+   configuration: docs/conf.py
+
+python:
+   install:
+   - requirements: requirements-dev.txt
+

Makefile

@@ -53,7 +53,9 @@ dist: pip
 
 # Target to generate HTML documentation
 docs: pip-dev
-	.venv/bin/sphinx-build -M html docs build/docs
+	. .venv/bin/activate; \
+	pip install -e .; \
+	sphinx-build -M html docs build/docs
 	@echo "Documentation generated to build/docs/html/."
 
 # Target to read the HTML documentation

docs/akkudoktoreos/serverapi.md

@@ -3,5 +3,5 @@
 # Server API
 
 ```{eval-sh}
-./scripts/generate_openapi_md.py | ./scripts/extract_markdown.py --input-stdin --start-line "**Version**:"
+python ${READTHEDOCS_REPOSITORY_PATH:-.}/scripts/generate_openapi_md.py | python ${READTHEDOCS_REPOSITORY_PATH:-.}/scripts/extract_markdown.py --input-stdin --start-line "**Version**:"
 ```

docs/develop/CONTRIBUTING.md

@@ -1,3 +1,3 @@
 ```{eval-sh}
-./scripts/extract_markdown.py --input-file CONTRIBUTING.md
+python ${READTHEDOCS_REPOSITORY_PATH:-.}/scripts/extract_markdown.py --input-file ${READTHEDOCS_REPOSITORY_PATH:-.}/CONTRIBUTING.md
 ```

docs/develop/getting_started.md

@@ -1,5 +1,5 @@
 # Getting Started
 
 ```{eval-sh}
-./scripts/extract_markdown.py --input-file README.md --start-line "## Getting Involved"
+python ${READTHEDOCS_REPOSITORY_PATH:-.}/scripts/extract_markdown.py --input-file ${READTHEDOCS_REPOSITORY_PATH:-.}/README.md --start-line "## Getting Involved"
 ```