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

…trings

Wip/update docs docstrings

docs/source/_autosummary/parallax.axis_filter.rst

@@ -0,0 +1,29 @@
+parallax.axis\_filter
+=====================
+
+.. automodule:: parallax.axis_filter
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AxisFilter
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.bundle_adjustment.rst

@@ -0,0 +1,30 @@
+parallax.bundle\_adjustment
+===========================
+
+.. automodule:: parallax.bundle_adjustment
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BALOptimizer
+      BALProblem
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.calculator.rst

@@ -0,0 +1,29 @@
+parallax.calculator
+===================
+
+.. automodule:: parallax.calculator
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Calculator
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.calibration_camera.rst

@@ -0,0 +1,30 @@
+parallax.calibration\_camera
+============================
+
+.. automodule:: parallax.calibration_camera
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CalibrationCamera
+      CalibrationStereo
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.camera.rst

@@ -0,0 +1,38 @@
+parallax.camera
+===============
+
+.. automodule:: parallax.camera
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      close_cameras
+      list_cameras
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MockCamera
+      PySpinCamera
+      VideoSource
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.coords_transformation.rst

@@ -0,0 +1,29 @@
+parallax.coords\_transformation
+===============================
+
+.. automodule:: parallax.coords_transformation
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      RotationTransformation
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.curr_bg_cmp_processor.rst

@@ -0,0 +1,29 @@
+parallax.curr\_bg\_cmp\_processor
+=================================
+
+.. automodule:: parallax.curr_bg_cmp_processor
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CurrBgCmpProcessor
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.curr_prev_cmp_processor.rst

@@ -0,0 +1,29 @@
+parallax.curr\_prev\_cmp\_processor
+===================================
+
+.. automodule:: parallax.curr_prev_cmp_processor
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CurrPrevCmpProcessor
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.main_window_wip.rst

@@ -0,0 +1,29 @@
+parallax.main\_window\_wip
+==========================
+
+.. automodule:: parallax.main_window_wip
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MainWindow
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.mask_generator.rst

@@ -0,0 +1,29 @@
+parallax.mask\_generator
+========================
+
+.. automodule:: parallax.mask_generator
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MaskGenerator
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.model.rst

@@ -0,0 +1,29 @@
+parallax.model
+==============
+
+.. automodule:: parallax.model
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Model
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/parallax.no_filter.rst

@@ -0,0 +1,29 @@
+parallax.no\_filter
+===================
+
+.. automodule:: parallax.no_filter
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      NoFilter
+
+
+
+
+
+
+
+
+