Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-f-cruz committed May 24, 2024
1 parent 6762d6a commit 2a23889
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/api.calibration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ api.calibration
-------------

Check warning on line 2 in docs/api.calibration.rst

View workflow job for this annotation

GitHub Actions / pages

Title underline too short.

.. toctree::
:maxdepth: 2
:maxdepth: 3

api.calibration/aind_manipulator
api.calibration/load_cells
Expand Down
16 changes: 7 additions & 9 deletions docs/api.calibration/aind_manipulator.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
aind_manipulator
-------------
-----------------

.. literalinclude:: ../../examples/aind_manipulator.py
:language: python

.. autopydantic_model:: aind_behavior_services.calibration.aind_manipulator.CalibrationLogic
.. automodule:: aind_behavior_services.calibration.aind_manipulator
:members:
:undoc-members:
:show-inheritance:

.. autopydantic_model:: aind_behavior_services.calibration.aind_manipulator.CalibrationRig
:members:
:undoc-members:
:show-inheritance:
Example
--------

.. literalinclude:: ../../examples/aind_manipulator.py
:language: python
14 changes: 6 additions & 8 deletions docs/api.calibration/load_cells.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
load_cells
-------------

.. literalinclude:: ../../examples/load_cells.py
:language: python

.. autopydantic_model:: aind_behavior_services.calibration.load_cells.CalibrationLogic
.. automodule:: aind_behavior_services.calibration.load_cells
:members:
:undoc-members:
:show-inheritance:

.. autopydantic_model:: aind_behavior_services.calibration.load_cells.CalibrationRig
:members:
:undoc-members:
:show-inheritance:
Example
--------

.. literalinclude:: ../../examples/load_cells.py
:language: python
14 changes: 6 additions & 8 deletions docs/api.calibration/olfactometer.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
olfactometer
-------------

.. literalinclude:: ../../examples/olfactometer.py
:language: python

.. autopydantic_model:: aind_behavior_services.calibration.olfactometer.CalibrationLogic
.. automodule:: aind_behavior_services.calibration.olfactometer
:members:
:undoc-members:
:show-inheritance:

.. autopydantic_model:: aind_behavior_services.calibration.olfactometer.CalibrationRig
:members:
:undoc-members:
:show-inheritance:
Example
--------

.. literalinclude:: ../../examples/olfactometer.py
:language: python
14 changes: 6 additions & 8 deletions docs/api.calibration/water_valve.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
water_valve
-------------

.. literalinclude:: ../../examples/water_valve.py
:language: python

.. autopydantic_model:: aind_behavior_services.calibration.water_valve.CalibrationLogic
.. automodule:: aind_behavior_services.calibration.water_valve
:members:
:undoc-members:
:show-inheritance:

.. autopydantic_model:: aind_behavior_services.calibration.water_valve.CalibrationRig
:members:
:undoc-members:
:show-inheritance:
Example
--------

.. literalinclude:: ../../examples/water_valve.py
:language: python

0 comments on commit 2a23889

Please sign in to comment.