Improve the docs.

Author: tannewt

README.rst

@@ -13,6 +13,10 @@ Introduction
 This helper library provides higher level objects to control motors and servos based on one or more
 PWM outputs.
 
+The PWM inputs can be any object that have a 16-bit ``duty_cycle`` attribute. Its assumed that the
+frequency has already been configured appropriately. (Typically 50hz for servos and 1600hz for
+motors.)
+
 Dependencies
 =============
 This driver depends on:
@@ -23,11 +27,6 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 
-Usage Example
-=============
-
-TODO
-
 API Reference
 =============
 

adafruit_motor/motor.py

@@ -26,8 +26,9 @@
 Simple control of a DC motor. DC motors have two wires and should not be connected directly to
 the PWM connections. Instead use intermediate circuitry to control a much stronger power source with
 the PWM. The `Adafruit Stepper + DC Motor FeatherWing <https://www.adafruit.com/product/2927>`_,
-`Adafruit TB6612 1.2A DC/Stepper Motor Driver Breakout Board <>`_ and `Adafruit Motor/Stepper/Servo
-Shield for Arduino v2 Kit - v2.3 <https://www.adafruit.com/product/1438>`_ do this for popular form
+`Adafruit TB6612 1.2A DC/Stepper Motor Driver Breakout Board
+<https://www.adafruit.com/product/2448>`_ and `Adafruit Motor/Stepper/Servo Shield for Arduino v2
+Kit - v2.3 <https://www.adafruit.com/product/1438>`_ do this for popular form
 factors already.
 
 .. note:: The TB6612 boards feature three inputs XIN1, XIN2 and PWMX. Since we PWM the INs directly

adafruit_motor/stepper.py

@@ -23,7 +23,10 @@
 `adafruit_motor.stepper`
 ====================================================
 
-TODO(description)
+Stepper motors feature multiple wire coils that are used to rotate the magnets connected to the
+motor shaft in a precise way. Each increment of the motor is called a step. Stepper motors have a
+varying number of steps per rotation so check the motor's documentation to determine exactly how
+precise each step is.
 
 * Author(s): Tony DiCola, Scott Shawcroft
 """
@@ -57,13 +60,13 @@
 class StepperMotor:
     """A bipolar stepper motor or four coil unipolar motor.
 
-    :param ~pulseio.PWMOut ain1: `PWMOut`-compatible output connected to the driver for the first
+    :param ~pulseio.PWMOut ain1: `pulseio.PWMOut`-compatible output connected to the driver for the first
       coil (unipolar) or first input to first coil (bipolar).
-    :param ~pulseio.PWMOut ain2: `PWMOut`-compatible output connected to the driver for the third
+    :param ~pulseio.PWMOut ain2: `pulseio.PWMOut`-compatible output connected to the driver for the third
       coil (unipolar) or second input to first coil (bipolar).
-    :param ~pulseio.PWMOut bin1: `PWMOut`-compatible output connected to the driver for the second
+    :param ~pulseio.PWMOut bin1: `pulseio.PWMOut`-compatible output connected to the driver for the second
       coil (unipolar) or second input to second coil (bipolar).
-    :param ~pulseio.PWMOut bin2: `PWMOut`-compatible output connected to the driver for the fourth
+    :param ~pulseio.PWMOut bin2: `pulseio.PWMOut`-compatible output connected to the driver for the fourth
       coil (unipolar) or second input to second coil (bipolar).
     :param int microsteps: Number of microsteps between full steps. Must be at least 2 and even.
     """

conf.py

@@ -18,7 +18,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["micropython"]
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
 
@@ -54,7 +54,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.