Merge pull request #71 from auscompgeek/mot-docs

Consolidate motor controller docs
robotpy · Dec 1, 2018 · 7dba327 · 7dba327
2 parents b8c9c3d + 2381912
commit 7dba327
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 29 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -15,6 +15,5 @@ refer to the `CTRE software guide <https://github.com/CrossTheRoadElec/Phoenix-D
 
     api_canifier
     api_pigeonimu
-    api_talonsrx
-    api_victorspx
+    api_mot
     api_misc
diff --git a/docs/api_mot.rst b/docs/api_mot.rst
@@ -0,0 +1,32 @@
+Motor Controllers
+=================
+
+TalonSRX
+--------
+
+.. autoclass:: ctre.WPI_TalonSRX
+    :members:
+    :show-inheritance:
+
+.. automodule:: ctre.talonsrx
+    :members:
+    :show-inheritance:
+
+VictorSPX
+---------
+
+.. autoclass:: ctre.WPI_VictorSPX
+    :members:
+    :show-inheritance:
+
+.. automodule:: ctre.victorspx
+    :members:
+    :show-inheritance:
+
+BaseMotorController
+-------------------
+
+.. automodule:: ctre.basemotorcontroller
+    :members:
+    :inherited-members:
+    :undoc-members:
diff --git a/docs/api_talonsrx.rst b/docs/api_talonsrx.rst
diff --git a/docs/api_victorspx.rst b/docs/api_victorspx.rst