Merge pull request #106 from AllenNeuralDynamics/wip/update_docs_docs…

…trings Wip/update docs docstrings
AllenNeuralDynamics · Oct 9, 2024 · f3b8857 · f3b8857
2 parents b27cc1e + 1121699
commit f3b8857
Show file tree

Hide file tree

Showing 59 changed files with 1,635 additions and 569 deletions.
diff --git a/docs/source/_autosummary/parallax.axis_filter.rst b/docs/source/_autosummary/parallax.axis_filter.rst
@@ -1,4 +1,4 @@
-parallax.axis\_filter
+parallax.axis\_filter
 =====================
 
 .. automodule:: parallax.axis_filter

diff --git a/docs/source/_autosummary/parallax.bundle_adjustment.rst b/docs/source/_autosummary/parallax.bundle_adjustment.rst
@@ -1,4 +1,4 @@
-parallax.bundle\_adjustment
+parallax.bundle\_adjustment
 ===========================
 
 .. automodule:: parallax.bundle_adjustment

diff --git a/docs/source/_autosummary/parallax.calculator.rst b/docs/source/_autosummary/parallax.calculator.rst
@@ -1,4 +1,4 @@
-parallax.calculator
+parallax.calculator
 ===================
 
 .. automodule:: parallax.calculator

diff --git a/docs/source/_autosummary/parallax.calibration_camera.rst b/docs/source/_autosummary/parallax.calibration_camera.rst
@@ -1,4 +1,4 @@
-parallax.calibration\_camera
+parallax.calibration\_camera
 ============================
 
 .. automodule:: parallax.calibration_camera

diff --git a/docs/source/_autosummary/parallax.camera.rst b/docs/source/_autosummary/parallax.camera.rst
@@ -1,4 +1,4 @@
-parallax.camera
+parallax.camera
 ===============
 
 .. automodule:: parallax.camera

diff --git a/docs/source/_autosummary/parallax.coords_transformation.rst b/docs/source/_autosummary/parallax.coords_transformation.rst
@@ -1,4 +1,4 @@
-parallax.coords\_transformation
+parallax.coords\_transformation
 ===============================
 
 .. automodule:: parallax.coords_transformation

diff --git a/docs/source/_autosummary/parallax.curr_bg_cmp_processor.rst b/docs/source/_autosummary/parallax.curr_bg_cmp_processor.rst
@@ -1,4 +1,4 @@
-parallax.curr\_bg\_cmp\_processor
+parallax.curr\_bg\_cmp\_processor
 =================================
 
 .. automodule:: parallax.curr_bg_cmp_processor

diff --git a/docs/source/_autosummary/parallax.curr_prev_cmp_processor.rst b/docs/source/_autosummary/parallax.curr_prev_cmp_processor.rst
@@ -1,4 +1,4 @@
-parallax.curr\_prev\_cmp\_processor
+parallax.curr\_prev\_cmp\_processor
 ===================================
 
 .. automodule:: parallax.curr_prev_cmp_processor

diff --git a/docs/source/_autosummary/parallax.main_window_wip.rst b/docs/source/_autosummary/parallax.main_window_wip.rst
@@ -1,4 +1,4 @@
-parallax.main\_window\_wip
+parallax.main\_window\_wip
 ==========================
 
 .. automodule:: parallax.main_window_wip

diff --git a/docs/source/_autosummary/parallax.mask_generator.rst b/docs/source/_autosummary/parallax.mask_generator.rst
@@ -1,4 +1,4 @@
-parallax.mask\_generator
+parallax.mask\_generator
 ========================
 
 .. automodule:: parallax.mask_generator

diff --git a/docs/source/_autosummary/parallax.model.rst b/docs/source/_autosummary/parallax.model.rst
@@ -1,4 +1,4 @@
-parallax.model
+parallax.model
 ==============
 
 .. automodule:: parallax.model

diff --git a/docs/source/_autosummary/parallax.no_filter.rst b/docs/source/_autosummary/parallax.no_filter.rst
@@ -1,4 +1,4 @@
-parallax.no\_filter
+parallax.no\_filter
 ===================
 
 .. automodule:: parallax.no_filter

diff --git a/docs/source/_autosummary/parallax.point_mesh.rst b/docs/source/_autosummary/parallax.point_mesh.rst
@@ -1,4 +1,4 @@
-parallax.point\_mesh
+parallax.point\_mesh
 ====================
 
 .. automodule:: parallax.point_mesh

diff --git a/docs/source/_autosummary/parallax.probe_calibration.rst b/docs/source/_autosummary/parallax.probe_calibration.rst
@@ -1,4 +1,4 @@
-parallax.probe\_calibration
+parallax.probe\_calibration
 ===========================
 
 .. automodule:: parallax.probe_calibration

diff --git a/docs/source/_autosummary/parallax.probe_detect_manager.rst b/docs/source/_autosummary/parallax.probe_detect_manager.rst
@@ -1,4 +1,4 @@
-parallax.probe\_detect\_manager
+parallax.probe\_detect\_manager
 ===============================
 
 .. automodule:: parallax.probe_detect_manager

diff --git a/docs/source/_autosummary/parallax.probe_detector.rst b/docs/source/_autosummary/parallax.probe_detector.rst
@@ -1,4 +1,4 @@
-parallax.probe\_detector
+parallax.probe\_detector
 ========================
 
 .. automodule:: parallax.probe_detector

diff --git a/docs/source/_autosummary/parallax.probe_fine_tip_detector.rst b/docs/source/_autosummary/parallax.probe_fine_tip_detector.rst
@@ -1,4 +1,4 @@
-parallax.probe\_fine\_tip\_detector
+parallax.probe\_fine\_tip\_detector
 ===================================
 
 .. automodule:: parallax.probe_fine_tip_detector

diff --git a/docs/source/_autosummary/parallax.recording_manager.rst b/docs/source/_autosummary/parallax.recording_manager.rst
@@ -1,4 +1,4 @@
-parallax.recording\_manager
+parallax.recording\_manager
 ===========================
 
 .. automodule:: parallax.recording_manager

diff --git a/docs/source/_autosummary/parallax.reticle_detect_manager.rst b/docs/source/_autosummary/parallax.reticle_detect_manager.rst
@@ -1,4 +1,4 @@
-parallax.reticle\_detect\_manager
+parallax.reticle\_detect\_manager
 =================================
 
 .. automodule:: parallax.reticle_detect_manager

diff --git a/docs/source/_autosummary/parallax.reticle_detection.rst b/docs/source/_autosummary/parallax.reticle_detection.rst
@@ -1,4 +1,4 @@
-parallax.reticle\_detection
+parallax.reticle\_detection
 ===========================
 
 .. automodule:: parallax.reticle_detection

diff --git a/docs/source/_autosummary/parallax.reticle_detection_coords_interests.rst b/docs/source/_autosummary/parallax.reticle_detection_coords_interests.rst
@@ -1,4 +1,4 @@
-parallax.reticle\_detection\_coords\_interests
+parallax.reticle\_detection\_coords\_interests
 ==============================================
 
 .. automodule:: parallax.reticle_detection_coords_interests

diff --git a/docs/source/_autosummary/parallax.reticle_metadata.rst b/docs/source/_autosummary/parallax.reticle_metadata.rst
@@ -1,4 +1,4 @@
-parallax.reticle\_metadata
+parallax.reticle\_metadata
 ==========================
 
 .. automodule:: parallax.reticle_metadata

diff --git a/docs/source/_autosummary/parallax.rst b/docs/source/_autosummary/parallax.rst
diff --git a/docs/source/_autosummary/parallax.screen_coords_mapper.rst b/docs/source/_autosummary/parallax.screen_coords_mapper.rst
@@ -1,4 +1,4 @@
-parallax.screen\_coords\_mapper
+parallax.screen\_coords\_mapper
 ===============================
 
 .. automodule:: parallax.screen_coords_mapper

diff --git a/docs/source/_autosummary/parallax.screen_widget.rst b/docs/source/_autosummary/parallax.screen_widget.rst
@@ -1,4 +1,4 @@
-parallax.screen\_widget
+parallax.screen\_widget
 =======================
 
 .. automodule:: parallax.screen_widget

diff --git a/docs/source/_autosummary/parallax.stage_controller.rst b/docs/source/_autosummary/parallax.stage_controller.rst
@@ -1,4 +1,4 @@
-parallax.stage\_controller
+parallax.stage\_controller
 ==========================
 
 .. automodule:: parallax.stage_controller

diff --git a/docs/source/_autosummary/parallax.stage_listener.rst b/docs/source/_autosummary/parallax.stage_listener.rst
@@ -1,4 +1,4 @@
-parallax.stage\_listener
+parallax.stage\_listener
 ========================
 
 .. automodule:: parallax.stage_listener

diff --git a/docs/source/_autosummary/parallax.stage_ui.rst b/docs/source/_autosummary/parallax.stage_ui.rst
@@ -1,4 +1,4 @@
-parallax.stage\_ui
+parallax.stage\_ui
 ==================
 
 .. automodule:: parallax.stage_ui

diff --git a/docs/source/_autosummary/parallax.stage_widget.rst b/docs/source/_autosummary/parallax.stage_widget.rst
@@ -1,4 +1,4 @@
-parallax.stage\_widget
+parallax.stage\_widget
 ======================
 
 .. automodule:: parallax.stage_widget

diff --git a/docs/source/_autosummary/parallax.user_setting_manager.rst b/docs/source/_autosummary/parallax.user_setting_manager.rst
@@ -1,4 +1,4 @@
-parallax.user\_setting\_manager
+parallax.user\_setting\_manager
 ===============================
 
 .. automodule:: parallax.user_setting_manager

diff --git a/docs/source/_autosummary/parallax.utils.rst b/docs/source/_autosummary/parallax.utils.rst
@@ -1,4 +1,4 @@
-parallax.utils
+parallax.utils
 ==============
 
 .. automodule:: parallax.utils

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,7 +20,12 @@
 copyright = f"{current_year}, {INSTITUTE_NAME}"
 author = INSTITUTE_NAME
 release = "0.0.1" # Automatically set version from parallax package
-autosummary_generate = True
+
+autosummary_generate = True # Automatically generate stub files for autosummary
+autoclass_content = "both"
+autodoc_default_options = {
+    'private-members': True,   # Include private members
+}
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -8,12 +8,42 @@ Summary
    :toctree: _autosummary
    :recursive:
 
-   parallax
+   parallax.calculator
+   parallax.calibration_camera
+   parallax.camera
+   parallax.coords_transformation
+   parallax.curr_bg_cmp_processor
+   parallax.curr_prev_cmp_processor
+   parallax.main_window_wip
+   parallax.mask_generator
+   parallax.model
+   parallax.no_filter
+   parallax.axis_filter
+   parallax.bundle_adjustment
+   parallax.probe_calibration
+   parallax.probe_detect_manager
+   parallax.probe_detector
+   parallax.probe_fine_tip_detector
+   parallax.recording_manager
+   parallax.reticle_detect_manager
+   parallax.reticle_detection
+   parallax.reticle_detection_coords_interests
+   parallax.screen_widget
+   parallax.stage_listener
+   parallax.stage_ui
+   parallax.stage_widget
+   parallax.utils
+   parallax.point_mesh
+   parallax.reticle_metadata
+   parallax.screen_coords_mapper
+   parallax.stage_controller
+   parallax.user_setting_manager
 
 Detailed Modules
 ----------------
-
+ 
 .. toctree::
    :maxdepth: 2
-
-   parallax
+
+   parallaxModules
+