Updated documentation

cedadev · Jan 8, 2025 · a693dce · a693dce
1 parent e35a062
commit a693dce
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 9 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -56,6 +56,7 @@ The ingestion/cataloging phase is not currently implemented for public use but m
 
    Projects <project_source>
    Groups <group_source>
+   Phases <phase_source>
    Filehandlers, Logs, and Utilities <misc_source>
 
 Indices and Tables

diff --git a/docs/source/phase_source.rst b/docs/source/phase_source.rst
@@ -0,0 +1,35 @@
+================
+Phased Operators
+================
+
+Scan Operations
+---------------
+
+.. automodule:: padocc.phases.scan
+    :members:
+    :show-inheritance:
+
+Compute Operations
+---------------
+
+.. automodule:: padocc.phases.compute
+    :members:
+    :show-inheritance:
+
+Validate Operations
+---------------
+
+.. automodule:: padocc.phases.validate
+    :members:
+    :show-inheritance:
+
+Ingest Operations
+---------------
+
+.. note::
+
+    Not featured in this development, the ingest operations are still being planned and scoped.
+
+.. automodule:: padocc.phases.ingest
+    :members:
+    :show-inheritance:
diff --git a/docs/source/phases.rst b/docs/source/phases.rst
@@ -40,8 +40,6 @@ The scan phase can be activated with the following:
 
     mygroup.run('scan',mode='kerchunk')
 
-.. automodule:: padocc.phases.scan
-    :members:
 
 Compute
 -------
@@ -74,10 +72,6 @@ Computation can be executed in serial for a group with the following:
 
     mygroup.run('compute',mode='kerchunk')
 
-.. automodule:: padocc.phases.compute
-    :members:
-    :show-inheritance:
-
 Validate
 --------
 
@@ -108,9 +102,6 @@ validator which checks the Xarray representations and identifies differences in
     # The validation reports will be saved to the filesystem for each project in this group
     # as 'data_report.json' and 'metadata_report.json'
 
-.. automodule:: padocc.phases.validate
-    :members:
-
 Next Steps
 ----------