equinor · koropets · May 29, 2023 · May 23, 2023 · May 23, 2023 · May 24, 2023
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -41,3 +41,21 @@ jobs:
 
       - name: Test ${{ matrix.component }}
         run: bash scripts/tests.sh -n -p ${{ matrix.component }}
+
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.10'
+          architecture: 'x64'
+
+      - name: Install deps
+        run: |
+          pip install --upgrade pip
+          pip install .[docs]
+
+      - name: Build Docs
+        run: make docs
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -12,10 +12,9 @@ sphinx:
 formats: all
 
 python:
-  version: 3.7
-  system_packages: true
   install:
     - method: pip
       path: .
       extra_requirements:
         - docs
+  system_packages: true
diff --git a/README.md b/README.md
@@ -33,6 +33,8 @@ Gordo fulfills the role of inhaling config files and supplying components to the
 * [gordo-core](https://github.com/equinor/gordo-core/) - Gordo core library.
 * [gordo-client](https://github.com/equinor/gordo-client/) - Gordo server's client. It is able to make predictions from deployed models.
 
+[Documentation is available on Read the Docs](https://gordo1.readthedocs.io/)
+
 ---
 ## Install
 
@@ -108,3 +110,10 @@ pytest -m 'dockertest'
 > **_NOTE:_** this example is for Pycharm IDE to use `breakpoints` in the code of the tests.  
 > On the configuration setup for test running add to `Additional arguments:` in `pytest` 
 > section following string: `--ignore benchmarks --cov-report= --no-cov ` 
+
+### Build the documentation
+
+```console
+> cd docs/
+> make watch
+```
diff --git a/docs/Makefile b/docs/Makefile
@@ -13,7 +13,13 @@ help:
 
 .PHONY: help Makefile
 
+_static/architecture_diagram.png:
+	python3 ./_static/architecture_diagram.py
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: Makefile _static/architecture_diagram.png
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+watch: _static/architecture_diagram.png
+	sphinx-autobuild --watch "$(SOURCEDIR)/../gordo" "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_static/architecture_diagram.png b/docs/_static/architecture_diagram.png
diff --git a/docs/_static/architecture_diagram.py b/docs/_static/architecture_diagram.py
@@ -0,0 +1,39 @@
+import os
+
+from diagrams import Diagram, Cluster
+from diagrams.onprem.compute import Server
+from diagrams.oci.compute import Functions
+from diagrams.k8s.controlplane import API
+from diagrams.k8s.others import CRD
+from diagrams.k8s.compute import Job, Pod
+from diagrams.k8s.storage import PV
+from diagrams.custom import Custom
+
+directory=os.path.dirname(__file__)
+
+with Diagram("Gordo flow", filename=os.path.join(directory, "architecture_diagram"), outformat="png", show=False) as diag:
+    with Cluster("K8s"):
+        gordo = CRD("Gordo")
+        api = API("")
+        with Cluster("gordo-controller"):
+            Server("API")
+            controller = Functions("Controller")
+        with Cluster("gordo-server"):
+            server_api = Server("API")
+        dpl_job = Job("dpl")
+        workflow = Custom("Workflow", os.path.join(directory, "./argo_logo.png"))
+        model = CRD("Model")
+        gordo_volume = PV("storage")
+        model_builder1 = Pod("model_builder1")
+        model_builder2 = Pod("model_builder2")
+    gordo >> api
+    workflow >> model
+    api >> controller
+    controller >> dpl_job
+    dpl_job >> workflow
+    workflow >> model_builder1
+    workflow >> model_builder2
+    model_builder1 >> gordo_volume
+    model_builder2 >> gordo_volume
+    workflow >> server_api
+    gordo_volume >> server_api
diff --git a/docs/_static/argo_logo.png b/docs/_static/argo_logo.png
diff --git a/docs/components/builder.rst → docs/api/builder.rst b/docs/components/builder.rst → docs/api/builder.rst
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,12 @@
+API
+---
+
+.. toctree::
+    :maxdepth: 2
+
+    ./builder.rst
+    ./serializer.rst
+    ./util.rst
+    ./workflow.rst
+    ./server/index.rst
+    ./machine/index.rst
diff --git a/docs/api/machine/index.rst b/docs/api/machine/index.rst
@@ -0,0 +1,10 @@
+Machine
+-------
+
+.. toctree::
+    :maxdepth: 2
+
+    ./machine.rst
+    ./metadata.rst
+    ./validators.rst
+    ./model/index.rst
diff --git a/docs/api/machine/machine.rst b/docs/api/machine/machine.rst
@@ -0,0 +1,10 @@
+Machine
+-------
+
+A ``Machine`` is the central unity of a model, dataset, metadata and everything
+needed to create and build a ML model.
+
+.. automodule:: gordo.machine.machine
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/components/machine/metadata.rst → docs/api/machine/metadata.rst b/docs/components/machine/metadata.rst → docs/api/machine/metadata.rst
diff --git a/docs/components/machine/model/anomaly.rst → docs/api/machine/model/anomaly.rst b/docs/components/machine/model/anomaly.rst → docs/api/machine/model/anomaly.rst
diff --git a/docs/api/machine/model/index.rst b/docs/api/machine/model/index.rst
@@ -0,0 +1,10 @@
+Model
+-----
+
+.. toctree::
+    :maxdepth: 2
+
+    ./anomaly.rst
+    ./model-factories.rst
+    ./transformer-funcs.rst
+    ./transformers.rst
diff --git a/...ponents/machine/model/model-factories.rst → docs/api/machine/model/model-factories.rst b/...ponents/machine/model/model-factories.rst → docs/api/machine/model/model-factories.rst
diff --git a/...nents/machine/model/transformer-funcs.rst → docs/api/machine/model/transformer-funcs.rst b/...nents/machine/model/transformer-funcs.rst → docs/api/machine/model/transformer-funcs.rst
diff --git a/...components/machine/model/transformers.rst → docs/api/machine/model/transformers.rst b/...components/machine/model/transformers.rst → docs/api/machine/model/transformers.rst
diff --git a/docs/components/machine/validators.rst → docs/api/machine/validators.rst b/docs/components/machine/validators.rst → docs/api/machine/validators.rst
diff --git a/docs/components/serializer.rst → docs/api/serializer.rst b/docs/components/serializer.rst → docs/api/serializer.rst
diff --git a/docs/components/server/anomaly.rst → docs/api/server/anomaly.rst b/docs/components/server/anomaly.rst → docs/api/server/anomaly.rst
@@ -5,7 +5,7 @@ The anomaly view into the model. Expects that the model being served
 when accessing this route implements the ``anomaly()`` method
 in order to calculate the anomaly key(s) for the response.
 
-.. automodule:: gordo.server.views.anomaly
+.. automodule:: gordo.server.blueprints.anomaly
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/components/server/base.rst → docs/api/server/base.rst b/docs/components/server/base.rst → docs/api/server/base.rst
@@ -5,7 +5,7 @@ Provides the most basic view into the model. This view will
 simply apply the model to the provided data and return the
 ``model-output`` along with the ``model-output``
 
-.. automodule:: gordo.server.views.base
+.. automodule:: gordo.server.blueprints.base
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/api/server/index.rst b/docs/api/server/index.rst
@@ -0,0 +1,10 @@
+Server
+------
+
+.. toctree::
+    :maxdepth: 2
+
+    ./server.rst
+    ./base.rst
+    ./anomaly.rst
+    ./utils.rst
diff --git a/docs/api/server/server.rst b/docs/api/server/server.rst
@@ -0,0 +1,7 @@
+Server
+---------
+
+.. automodule:: gordo.server.server
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/server/utils.rst b/docs/api/server/utils.rst
@@ -0,0 +1,14 @@
+Utils
+-----
+
+.. automodule:: gordo.server.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The general model input/output operations applied by blueprints.
+
+.. automodule:: gordo.server.model_io
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/components/util.rst → docs/api/util.rst b/docs/components/util.rst → docs/api/util.rst
diff --git a/docs/components/workflow.rst → docs/api/workflow.rst b/docs/components/workflow.rst → docs/api/workflow.rst
diff --git a/docs/components/machine/machine.rst b/docs/components/machine/machine.rst
diff --git a/docs/components/machine/model/model.rst b/docs/components/machine/model/model.rst
diff --git a/docs/components/server/server.rst b/docs/components/server/server.rst