Merge pull request #24 from OPSORO/Development

Documenting
OPSORO · Aug 17, 2017 · 3ea6a7e · 3ea6a7e
2 parents fc02674 + a1e18d7
commit 3ea6a7e
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 3 deletions.
diff --git a/docs/modules/hardware.rst b/docs/modules/hardware.rst
@@ -9,6 +9,39 @@ opsoro.hardware
     :show-inheritance:
 
 
+.. _sec-modules-hardware-analog:
+
+opsoro.hardware.analog
+-------------------
+
+.. automodule:: opsoro.hardware.analog
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. _sec-modules-hardware-capacitive:
+
+opsoro.hardware.capacitive
+-------------------
+
+.. automodule:: opsoro.hardware.capacitive
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. _sec-modules-hardware-dummy_spidev:
+
+opsoro.hardware.dummy_spidev
+-------------------
+
+.. automodule:: opsoro.hardware.dummy_spidev
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
 .. _sec-modules-hardware-i2c:
 
 opsoro.hardware.i2c
@@ -18,3 +51,47 @@ opsoro.hardware.i2c
     :members:
     :undoc-members:
     :show-inheritance:
+
+
+.. _sec-modules-hardware-neopixel:
+
+opsoro.hardware.neopixel
+-------------------
+
+.. automodule:: opsoro.hardware.neopixel
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. _sec-modules-hardware-servo:
+
+opsoro.hardware.servo
+-------------------
+
+.. automodule:: opsoro.hardware.servo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. _sec-modules-hardware-usb_serial:
+
+opsoro.hardware.usb_serial
+-------------------
+
+.. automodule:: opsoro.hardware.usb_serial
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. _sec-modules-hardware-test_hardware:
+
+opsoro.hardware.test_hardware
+-------------------
+
+.. automodule:: opsoro.hardware.test_hardware
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/modules/module.rst b/docs/modules/module.rst
@@ -42,12 +42,12 @@ opsoro.module.mouth
     :show-inheritance:
 
 
-.. _sec-modules-module-rotation:
+.. _sec-modules-module-turn:
 
-opsoro.module.rotation
+opsoro.module.turn
 -----------------------------
 
-.. automodule:: opsoro.module.rotation
+.. automodule:: opsoro.module.turn
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/src/opsoro/animate.py b/src/opsoro/animate.py
@@ -1,3 +1,12 @@
+"""
+This module defines the interface for animating an expression.
+
+.. autoclass:: Animate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+"""
+
 from __future__ import division
 
 import time