Merge pull request #481 from dirac-institute/documentation

Clean up documentation API Links
dirac-institute · Feb 23, 2024 · e1ba8c4 · e1ba8c4
2 parents b421846 + fa3d740
commit e1ba8c4
Show file tree

Hide file tree

Showing 13 changed files with 65 additions and 5 deletions.
diff --git a/docs/source/api_reference/configuration.rst b/docs/source/api_reference/configuration.rst
@@ -0,0 +1,5 @@
+Module: configuration
+=====================
+
+.. automodule:: kbmod.configuration
+   :members:
diff --git a/...ource/api_reference/fake_data_creator.rst → ...reference/fake_data/fake_data_creator.rst b/...ource/api_reference/fake_data_creator.rst → ...reference/fake_data/fake_data_creator.rst
@@ -1,5 +1,5 @@
 Module: fake_data_creator
 =========================
 
-.. automodule:: kbmod.fake_data_creator
+.. automodule:: kbmod.fake_data.fake_data_creator
    :members:
diff --git a/docs/source/api_reference/fake_data/insert_fake_orbit.rst b/docs/source/api_reference/fake_data/insert_fake_orbit.rst
@@ -0,0 +1,5 @@
+Module: insert_fake_orbit
+=========================
+
+.. automodule:: kbmod.fake_data.insert_fake_orbit
+   :members:
diff --git a/docs/source/api_reference/image_collection.rst b/docs/source/api_reference/image_collection.rst
@@ -0,0 +1,5 @@
+Module:image_collection
+=======================
+
+.. automodule:: kbmod.image_collection
+   :members:
diff --git a/docs/source/api_reference/index.rst b/docs/source/api_reference/index.rst
@@ -7,9 +7,21 @@ Object Search
 .. toctree::
    :maxdepth: 1
 
+   configuration
    run_search_referenceapi
    search_referenceapi
+   trajectory_explorer
+   work_unit
 
+Preprocessing
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
+   image_collection
+   masking
+   reprojection
 
 Filtering Results
 -----------------
@@ -37,5 +49,8 @@ Miscelaneous utilities
 .. toctree::
    :maxdepth: 1
 
-   fake_data_creator
+   fake_data/fake_data_creator
+   fake_data/insert_fake_orbit
    file_utils
+   trajectory_utils
+   wcs_utils
diff --git a/docs/source/api_reference/masking.rst b/docs/source/api_reference/masking.rst
@@ -0,0 +1,5 @@
+Module: masking
+===============
+
+.. automodule:: kbmod.masking
+   :members:
diff --git a/docs/source/api_reference/reprojection.rst b/docs/source/api_reference/reprojection.rst
@@ -0,0 +1,5 @@
+Module: reprojection
+====================
+
+.. automodule:: kbmod.reprojection
+   :members:
diff --git a/docs/source/api_reference/trajectory_explorer.rst b/docs/source/api_reference/trajectory_explorer.rst
@@ -0,0 +1,5 @@
+Module: trajectory_explorer
+===========================
+
+.. automodule:: kbmod.trajectory_explorer
+   :members:
diff --git a/docs/source/api_reference/trajectory_utils.rst b/docs/source/api_reference/trajectory_utils.rst
@@ -0,0 +1,5 @@
+Module: trajectory_utils
+========================
+
+.. automodule:: kbmod.trajectory_utils
+   :members:
diff --git a/docs/source/api_reference/wcs_utils.rst b/docs/source/api_reference/wcs_utils.rst
@@ -0,0 +1,5 @@
+Module: wcs_utils
+=================
+
+.. automodule:: kbmod.wcs_utils
+   :members:
diff --git a/docs/source/api_reference/work_unit.rst b/docs/source/api_reference/work_unit.rst
@@ -0,0 +1,5 @@
+Module: work_unit
+=================
+
+.. automodule:: kbmod.work_unit
+   :members:
diff --git a/src/kbmod/fake_data/insert_fake_orbit.py b/src/kbmod/fake_data/insert_fake_orbit.py
@@ -1,6 +1,6 @@
 from astropy.wcs import WCS
 
-from kbmod.fake_orbits.pyoorb_helper import PyoorbOrbit
+from kbmod.fake_data.pyoorb_helper import PyoorbOrbit
 from kbmod.search import ImageStack, LayeredImage, PSF, RawImage
 from kbmod.work_unit import WorkUnit
 

diff --git a/src/kbmod/image_collection.py b/src/kbmod/image_collection.py
@@ -373,8 +373,8 @@ def get_standardizer(self, index, **kwargs):
         A helper function that allows for access to non-required common
         properties such as standardizer object, WCS, bounding boxes etc.
 
-        Parameter
-        --------
+        Parameters
+        ----------
         index : `int`
             Index, as it appears in the unravelled table of metadata
             properties.