update docstrings

f1tenth · Mar 3, 2024 · 9beb5fa · 9beb5fa
1 parent 4c0335e
commit 9beb5fa
Show file tree

Hide file tree

Showing 4 changed files with 477 additions and 181 deletions.
diff --git a/docs/src/api/action.rst b/docs/src/api/action.rst
@@ -0,0 +1,21 @@
+Control Actions
+================
+
+Enums specifying different control input action types.
+
+.. currentmodule:: f110_gym.envs.action
+
+.. autosummary::
+    :toctree: _generated/
+
+    LongitudinalActionEnum
+    LongitudinalAction
+    AcclAction
+    SpeedAction
+    SteerActionEnum
+    SteerAction
+    SteeringAngleAction
+    SteeringSpeedAction
+    CarAction
+    from_single_to_multi_action_space
+
diff --git a/docs/src/api/index.rst b/docs/src/api/index.rst
@@ -7,6 +7,7 @@ API Overview
 
   env
   base_classes
+  action
   dynamic_models
   integrators
   laser_models