Add examples

AllenNeuralDynamics · Apr 25, 2024 · 035bb2b · 035bb2b
1 parent ea92993
commit 035bb2b
Show file tree

Hide file tree

Showing 11 changed files with 84 additions and 4 deletions.
diff --git a/docs/api.base.rst b/docs/api.base.rst
@@ -0,0 +1,9 @@
+api.base
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   api.base/session
+   api.base/rig
+   api.base/task_logic
diff --git a/docs/api/rig.rst → docs/api.base/rig.rst b/docs/api/rig.rst → docs/api.base/rig.rst
diff --git a/docs/api/session.rst → docs/api.base/session.rst b/docs/api/session.rst → docs/api.base/session.rst
diff --git a/docs/api/task_logic.rst → docs/api.base/task_logic.rst b/docs/api/task_logic.rst → docs/api.base/task_logic.rst
diff --git a/docs/api.calibration.rst b/docs/api.calibration.rst
@@ -0,0 +1,10 @@
+api.calibration
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   api.calibration/aind_manipulator
+   api.calibration/load_cells
+   api.calibration/olfactometer
+   api.calibration/water_valve
diff --git a/docs/api.calibration/aind_manipulator.rst b/docs/api.calibration/aind_manipulator.rst
@@ -0,0 +1,15 @@
+aind_manipulator
+-------------
+
+.. literalinclude:: ../../examples/aind_manipulator.py
+      :language: python
+
+.. autopydantic_model:: aind_behavior_services.calibration.aind_manipulator.CalibrationLogic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autopydantic_model:: aind_behavior_services.calibration.aind_manipulator.CalibrationRig
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api.calibration/load_cells.rst b/docs/api.calibration/load_cells.rst
@@ -0,0 +1,15 @@
+load_cells
+-------------
+
+.. literalinclude:: ../../examples/load_cells.py
+      :language: python
+
+.. autopydantic_model:: aind_behavior_services.calibration.load_cells.CalibrationLogic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autopydantic_model:: aind_behavior_services.calibration.load_cells.CalibrationRig
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api.calibration/olfactometer.rst b/docs/api.calibration/olfactometer.rst
@@ -0,0 +1,15 @@
+olfactometer
+-------------
+
+.. literalinclude:: ../../examples/olfactometer.py
+      :language: python
+
+.. autopydantic_model:: aind_behavior_services.calibration.olfactometer.CalibrationLogic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autopydantic_model:: aind_behavior_services.calibration.olfactometer.CalibrationRig
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api.calibration/water_valve.rst b/docs/api.calibration/water_valve.rst
@@ -0,0 +1,15 @@
+water_valve
+-------------
+
+.. literalinclude:: ../../examples/water_valve.py
+      :language: python
+
+.. autopydantic_model:: aind_behavior_services.calibration.water_valve.CalibrationLogic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autopydantic_model:: aind_behavior_services.calibration.water_valve.CalibrationRig
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api.rst b/docs/api.rst
@@ -4,6 +4,6 @@ api
 .. toctree::
    :maxdepth: 2
 
-   api/session
-   api/rig
-   api/task_logic
+   api.base
+   api.calibration
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,7 +40,8 @@ docs = [
     'sphinx-jinja',
     'autodoc_pydantic',
     'myst_parser',
-    'sphinx-jsonschema'
+    'sphinx-jsonschema',
+    'sphinx-copybutton'
 ]
 
 [tool.setuptools.packages.find]