Initial docs commit

cedadev · Jan 25, 2024 · 4f27b98 · 4f27b98
1 parent 706a39d
commit 4f27b98
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 2 deletions.
diff --git a/docs/source/assess-overview.rst b/docs/source/assess-overview.rst
@@ -0,0 +1,2 @@
+Assessor Tool
+=============
diff --git a/docs/source/assess.rst b/docs/source/assess.rst
@@ -0,0 +1,6 @@
+Assess Module
+=============
+
+.. automodule:: assess
+    :members:
+
diff --git a/docs/source/compute.rst b/docs/source/compute.rst
@@ -0,0 +1,8 @@
+Initialisation Module
+================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Processors:
+
+   Serial Process <serial-process>
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
diff --git a/docs/source/execution.rst b/docs/source/execution.rst
@@ -0,0 +1,8 @@
+Pipeline Execution
+==================
+
+.. automodule:: group_run
+    :members:
+
+.. automodule:: single_run
+    :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,8 +12,20 @@ Welcome to kerchunk-builder's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   Assessor Tool <assessor>
-   Serial Process <serial-process>
+   Pipeline Overview <pipeline-overview>
+   Execution <execution>
+   Worked Examples <examples>
+   Assessor Tool Overview <assess-overview>
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Advanced:
+
+   Init Source <init>
+   Scan Source <scan>
+   Compute Source <compute>
+   Validate Source <validate>
+   Assess Source <assess>
 
 
 

diff --git a/docs/source/init.rst b/docs/source/init.rst
@@ -0,0 +1,5 @@
+Initialisation Module
+================
+
+.. automodule:: pipeline.init
+    :members:
diff --git a/docs/source/pipeline-overview.rst b/docs/source/pipeline-overview.rst
diff --git a/docs/source/scan.rst b/docs/source/scan.rst
@@ -0,0 +1,5 @@
+Scanner Module
+================
+
+.. automodule:: pipeline.scan
+    :members:
diff --git a/docs/source/validate.rst b/docs/source/validate.rst
@@ -0,0 +1,5 @@
+Validation Module
+================
+
+.. automodule:: pipeline.validate
+    :members: