Issue #142 Initial Sphinx+MyST doc setup

docs/.gitignore

@@ -0,0 +1,4 @@
+build/
+_build/
+venv/
+.venv/

docs/conf.py

@@ -0,0 +1,19 @@
+project = "openEO Aggregator"
+
+extensions = [
+    "myst_parser",
+    "sphinx_design",
+    "sphinxcontrib.mermaid",
+]
+myst_enable_extensions = ["colon_fence"]
+
+root_doc = "index"
+html_theme = "furo"
+
+
+exclude_patterns = [
+    "_build",
+    "build",
+    ".venv",
+    "venv",
+]

docs/README.md → docs/index.md

@@ -5,7 +5,21 @@ The openEO Aggregator is a software component to group multiple openEO back-ends
 into a unified, federated openEO processing platform.
 
 
-## Background: openEO
+```{mermaid}
+flowchart LR
+
+U("👤 User") --> A("openEO Aggregator")
+
+subgraph federation ["Federated openEO Processing"]
+
+    A --> B1("openEO Back-end 1")
+    A --> B2("openEO Back-end 2")
+    A --> B3("openEO Back-end 3")
+end
+```
+
+
+## Core openEO API
 
 The [openEO API](https://openeo.org/) is an open, standardized API for Earth Observation data processing,
 connecting openEO-capable clients at the user side with openEO-capable back-ends at the (cloud) processing side.
@@ -33,3 +47,12 @@ including, but not limited to:
 - unified listing of batch jobs of a user across multiple back-ends
 - dispatching of simple processing requests (both for synchronous processing and batch jobs) to the appropriate back-end
 - handling of more complex processing requests that require data from multiple back-ends
+
+
+
+```{toctree}
+:hidden:
+pages/installation.md
+pages/configuration.md
+pages/usage.md
+```

docs/pages/configuration.md

@@ -0,0 +1,13 @@
+
+
+# Configuration
+
+
+
+The openEO Aggregator can be configured through a `AggregatorBackendConfig` class
+
+
+
+## Gunicorn configuration
+
+TODO

docs/pages/installation.md

@@ -0,0 +1,13 @@
+
+# Installation
+
+The openEO Aggregator can be installed via pip:
+
+```shell
+python -m pip install openeo-aggregator
+```
+
+
+## Requirements
+
+- Optional: a Zookeeper cluster for caching and partitioned job db

docs/pages/usage.md

@@ -0,0 +1,16 @@
+
+# Usage
+
+## Run with Flask in development mode
+
+```shell
+export FLASK_APP='openeo_aggregator.app:create_app()'
+export FLASK_ENV=development
+flask run
+```
+
+## Run with Gunicorn
+
+```shell
+gunicorn 'openeo_aggregator.app:create_app()'
+```

docs/requirements.txt

@@ -0,0 +1,5 @@
+Sphinx~=7.3.7
+myst-parser~=3.0.1
+sphinx-design~=0.6.0
+furo~=2024.5.6
+sphinxcontrib-mermaid~=0.9.2