doc/source/library_reference/common/lib/opencsp_path: Added

sandialabs · Jan 20, 2025 · 1fba17b · 1fba17b
1 parent 316eba7
commit 1fba17b
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/doc/source/library_reference/common/lib/opencsp_path/config.rst b/doc/source/library_reference/common/lib/opencsp_path/config.rst
@@ -0,0 +1,27 @@
+.. currentmodule:: opencsp.common.lib.opencsp_path.data_path_for_test
+
+.. automodule:: opencsp.common.lib.opencsp_path.data_path_for_test
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. currentmodule:: opencsp.common.lib.opencsp_path.opencsp_root_path
+
+.. automodule:: opencsp.common.lib.opencsp_path.opencsp_root_path
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. currentmodule:: opencsp.common.lib.opencsp_path.optical_analysis_data_path
+
+.. automodule:: opencsp.common.lib.opencsp_path.optical_analysis_data_path
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
diff --git a/doc/source/library_reference/common/lib/opencsp_path/index.rst b/doc/source/library_reference/common/lib/opencsp_path/index.rst
@@ -0,0 +1,9 @@
+Path Utilities
+===============
+
+This is a collection of path utilities for OpenCSP
+
+.. toctree::
+   :maxdepth: 1
+
+   config.rst
diff --git a/doc/source/library_reference/index.rst b/doc/source/library_reference/index.rst
@@ -16,3 +16,4 @@ This section describes the OpenCSP classes and interfaces.
    common/lib/csp/index.rst
    common/lib/file/index.rst
    common/lib/geometry/index.rst
+   common/lib/opencsp_path/index.rst