Sbachmei/mic 5561/add indexes to api (#134)

ihmeuw · Dec 30, 2024 · 1261e53 · 1261e53
1 parent 0d83c0f
commit 1261e53
Show file tree

Hide file tree

Showing 23 changed files with 70 additions and 0 deletions.
diff --git a/build-doc b/build-doc
@@ -0,0 +1 @@
+Ignore, Created by Makefile, Fri 27 Dec 2024 12:52:35 PM PST
diff --git a/docs/nitpick-exceptions b/docs/nitpick-exceptions
@@ -0,0 +1,3 @@
+py:class LayeredConfigTree
+py:class layered_config_tree.LayeredConfigTree
+py:class layered_config_tree.main.LayeredConfigTree
diff --git a/docs/source/api_reference/configuration.rst b/docs/source/api_reference/configuration.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.configuration
diff --git a/docs/source/api_reference/graph_components.rst b/docs/source/api_reference/graph_components.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.graph_components
diff --git a/docs/source/api_reference/implementation.rst b/docs/source/api_reference/implementation.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.implementation
diff --git a/docs/source/api_reference/index.rst b/docs/source/api_reference/index.rst
@@ -1,2 +1,11 @@
 API Reference
 =============
+
+.. automodule:: easylink
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *
+    */index
diff --git a/docs/source/api_reference/pipeline.rst b/docs/source/api_reference/pipeline.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.pipeline
diff --git a/docs/source/api_reference/pipeline_graph.rst b/docs/source/api_reference/pipeline_graph.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.pipeline_graph
diff --git a/docs/source/api_reference/pipeline_schema.rst b/docs/source/api_reference/pipeline_schema.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.pipeline_schema
diff --git a/docs/source/api_reference/pipeline_schema_constants/development.rst b/docs/source/api_reference/pipeline_schema_constants/development.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.pipeline_schema_constants.development
diff --git a/docs/source/api_reference/pipeline_schema_constants/index.rst b/docs/source/api_reference/pipeline_schema_constants/index.rst
@@ -0,0 +1,10 @@
+PipelineSchema Constants
+========================
+
+.. automodule:: easylink.pipeline_schema_constants
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *
diff --git a/docs/source/api_reference/pipeline_schema_constants/tests.rst b/docs/source/api_reference/pipeline_schema_constants/tests.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.pipeline_schema_constants.tests
diff --git a/docs/source/api_reference/rule.rst b/docs/source/api_reference/rule.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.rule
diff --git a/docs/source/api_reference/runner.rst b/docs/source/api_reference/runner.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.runner
diff --git a/docs/source/api_reference/step.rst b/docs/source/api_reference/step.rst
@@ -0,0 +1 @@
+.. automodule:: easylink.step
diff --git a/docs/source/api_reference/utilities/data_utils.rst b/docs/source/api_reference/utilities/data_utils.rst
@@ -0,0 +1,2 @@
+.. automodule:: easylink.utilities.data_utils
+
diff --git a/docs/source/api_reference/utilities/general_utils.rst b/docs/source/api_reference/utilities/general_utils.rst
@@ -0,0 +1,2 @@
+.. automodule:: easylink.utilities.general_utils
+
diff --git a/docs/source/api_reference/utilities/index.rst b/docs/source/api_reference/utilities/index.rst
@@ -0,0 +1,10 @@
+Utilities
+=========
+
+.. automodule:: easylink.utilities
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *
diff --git a/docs/source/api_reference/utilities/paths.rst b/docs/source/api_reference/utilities/paths.rst
@@ -0,0 +1,2 @@
+.. automodule:: easylink.utilities.paths
+
diff --git a/docs/source/api_reference/utilities/validation_utils.rst b/docs/source/api_reference/utilities/validation_utils.rst
@@ -0,0 +1,2 @@
+.. automodule:: easylink.utilities.validation_utils
+
diff --git a/src/easylink/pipeline_schema_constants/development.py b/src/easylink/pipeline_schema_constants/development.py
@@ -1,3 +1,9 @@
+"""
+============================
+Development Pipeline Schemas
+============================
+"""
+
 from easylink.graph_components import (
     EdgeParams,
     InputSlot,

diff --git a/src/easylink/pipeline_schema_constants/tests.py b/src/easylink/pipeline_schema_constants/tests.py
@@ -1,3 +1,9 @@
+"""
+=====================
+Test Pipeline Schemas
+=====================
+"""
+
 from easylink.graph_components import (
     EdgeParams,
     InputSlot,

diff --git a/src/easylink/utilities/paths.py b/src/easylink/utilities/paths.py
@@ -1,3 +1,9 @@
+"""
+=========
+Filepaths
+=========
+"""
+
 from pathlib import Path
 
 # TODO: We'll need to update this to be more generic for external users and have a way of configuring this
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Ignore, Created by Makefile, Fri 27 Dec 2024 12:52:35 PM PST
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. automodule:: easylink.pipeline_schema_constants.development
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. automodule:: easylink.utilities.data_utils
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. automodule:: easylink.utilities.general_utils
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. automodule:: easylink.utilities.validation_utils