Merge pull request #510 from lesamouraipourpre/docs

Add missing modules to the API documentation

diff --git a/README.rst b/README.rst
index d802c16077e6b17398021eaff1ec27229c9f0bf0..8f3aa290927d82c1ad7bb809e84730f2e92c40c8 100755 (executable)
--- a/README.rst
+++ b/README.rst
@@ -25,11 +25,13 @@ for devices or hosts running CPython or MicroPython. Working code exists to emul
 * **board** - breakout-specific pin identities
 * **busio** - hardware-driven interfaces for I2C, SPI, UART
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
+* **keypad** - support for scanning keys and key matrices
 * **microcontroller** - chip-specific pin identities
 * **micropython** - MicroPython-specific module
 * **neopixel_write** - low-level interface to NeoPixels
 * **pulseio** - contains classes that provide access to basic pulse IO (PWM)
 * **pwmio** - contains classes that provide access to basic pulse IO (PWM)
+* **rainbowio** - provides the colorwheel() function
 
 For details, see the `Blinka API reference
 <https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.

diff --git a/docs/api.rst b/docs/api.rst
index 61e9bbee5fc477d73425faa0a99dea71c333b0fb..dc0aeb6e660b85d9b152de70d174266abc4efbde 100755 (executable)
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -13,6 +13,9 @@
 .. automodule:: adafruit_blinka.microcontroller
   :members:
 
+.. automodule:: analogio
+  :members:
+
 .. automodule:: bitbangio
   :members:
 
@@ -25,13 +28,23 @@
 .. automodule:: digitalio
   :members:
 
-.. automodule:: analogio
+.. automodule:: keypad
   :members:
 
-.. automodule:: pulseio
+.. automodule:: microcontroller
+  :members:
+
+.. automodule:: micropython
   :members:
 
 .. automodule:: neopixel_write
   :members:
 
+.. automodule:: pulseio
+  :members:
+
+.. automodule:: pwmio
+  :members:
 
+.. automodule:: rainbowio
+  :members:

diff --git a/src/keypad.py b/src/keypad.py
index 97c58e782e9dc9f84ddca6f33e75f2cf485c73bc..a156d6e5add4fd0b951ca880d5e33b3618811292 100644 (file)
--- a/src/keypad.py
+++ b/src/keypad.py
@@ -462,7 +462,7 @@ class ShiftRegisterKeys(_KeysBase):
 
     @property
     def events(self):
-        """The `EventQueue` associated with this `Keys` object. (read-only)"""
+        """The ``EventQueue`` associated with this `Keys` object. (read-only)"""
         return self._events
 
     def _keypad_shiftregisterkeys_scan(self):

diff --git a/src/microcontroller/__init__.py b/src/microcontroller/__init__.py
index 9e05c81045ea5d1e9485ce6f47ba82ebdbd2adea..fda16cc109c9c1d7c9409e89b2cbe36c4efa10b0 100755 (executable)
--- a/src/microcontroller/__init__.py
+++ b/src/microcontroller/__init__.py
@@ -1,4 +1,9 @@
-"""Microcontroller pins"""
+"""
+`microcontroller` - Pin references and cpu functionality
+========================================================
+
+* Author(s): Melissa LeBlanc-Williams
+"""
 
 import sys
 import time
@@ -14,7 +19,12 @@ def delay_us(delay):
 
 
 class Pin(Enum):
-    """Reference Pin object"""
+    """
+    Identifies an IO pin on the microcontroller.
+
+    They are fixed by the hardware so they cannot be constructed on demand. Instead, use board or
+    microcontroller.pin to reference the desired pin.
+    """
 
     def __init__(self, pin_id):
         """Identifier for pin, referencing platform-specific pin id"""

diff --git a/src/micropython.py b/src/micropython.py
index 5f369e3f0df022d3594edd97633e5093ed303266..843d5a5704f0b517b5064dca524d011e7951b4ca 100755 (executable)
--- a/src/micropython.py
+++ b/src/micropython.py
@@ -1,6 +1,6 @@
 """
 `micropython` - MicroPython Specific Decorator Functions
-=================================================
+========================================================
 
 * Author(s): cefn
 """