Added/removed sofast doc files to pass doc checks.

sandialabs · Mar 25, 2024 · 04ec1ee · 04ec1ee
1 parent 63775b8
commit 04ec1ee
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 45 deletions.
diff --git a/doc/source/example/camera_calibration/config.rst b/doc/source/example/camera_calibration/config.rst
@@ -0,0 +1,8 @@
+View Camera Distortion
+======================
+
+.. currentmodule:: example.camera_calibration.example_view_camera_distortion
+
+.. automodule:: example.camera_calibration.example_view_camera_distortion
+   :members:
+   :show-inheritance:
diff --git a/doc/source/example/camera_calibration/index.rst b/doc/source/example/camera_calibration/index.rst
@@ -0,0 +1,11 @@
+Camera Calibration
+==================
+
+These are example files that provide examples on how to use OpenCSP for camera lens calibration.
+
+
+
+.. toctree::
+   :maxdepth: 1
+
+   config.rst
diff --git a/doc/source/example/index.rst b/doc/source/example/index.rst
@@ -6,6 +6,7 @@ This section describes the OpenCSP examples.
 .. toctree::
    :maxdepth: 1
 
+   camera_calibration/index.rst
    csp/index.rst
    mirror/index.rst
    scene_reconstruction/index.rst

diff --git a/doc/source/example/sofast/config.rst b/doc/source/example/sofast/config.rst
@@ -17,11 +17,3 @@ Undefined Facet Data Process
    :members:
    :show-inheritance:
 
-View Camera Distortion
-======================
-
-.. currentmodule:: example.sofast_fringe.example_calibration_camera_pose
-
-.. automodule:: example.sofast_fringe.example_calibration_camera_pose
-   :members:
-   :show-inheritance:
diff --git a/doc/source/example/sofast/index.rst b/doc/source/example/sofast/index.rst
@@ -1,7 +1,7 @@
-SoFast
-======
+SOFAST Fringe
+=============
 
-These are example files that provide examples on how to use Sofast to collect data and process already collected data.
+These are example files that provide examples on how to use Sofast Fringe to process collected data and perform system calibrations.
 
 
 

diff --git a/doc/source/library_reference/app/sofast/calibration/config.rst b/doc/source/library_reference/app/sofast/calibration/config.rst
diff --git a/doc/source/library_reference/app/sofast/calibration/index.rst b/doc/source/library_reference/app/sofast/calibration/index.rst
diff --git a/doc/source/library_reference/app/sofast/config.rst b/doc/source/library_reference/app/sofast/config.rst
@@ -116,4 +116,14 @@ opencsp.app.sofast.SofastGUI
 .. automodule:: opencsp.app.sofast.SofastGUI
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+opencsp.app.sofast.lib.CalibrateDisplayShape
+=============================================================
+
+.. currentmodule:: opencsp.app.sofast.lib.CalibrateDisplayShape
+
+.. automodule:: opencsp.app.sofast.lib.CalibrateDisplayShape
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/library_reference/app/sofast/index.rst b/doc/source/library_reference/app/sofast/index.rst
@@ -1,4 +1,4 @@
-sofast
+SOFAST
 ======
 
 High-precision deflectometry measurement of CSP mirrors, including heliostat facets, full heliostats, and dishes.
@@ -7,4 +7,3 @@ High-precision deflectometry measurement of CSP mirrors, including heliostat fac
    :maxdepth: 1
 
    config.rst
-   calibration/index.rst
diff --git a/example/camera_calibration/example_view_camera_distortion.py b/example/camera_calibration/example_view_camera_distortion.py
@@ -7,7 +7,7 @@
 from opencsp.common.lib.opencsp_path.opencsp_root_path import opencsp_code_dir
 
 
-def example_driver():
+def example_show_camera_distortion():
     """Example SOFAST script
 
     Plots visualization of camera distortion given a saved Camera HDF file
@@ -38,4 +38,4 @@ def example_driver():
 
 
 if __name__ == '__main__':
-    example_driver()
+    example_show_camera_distortion()