From: James Carr <lesamouraipourpre@gmail.com>
Date: Tue, 21 Sep 2021 11:42:05 +0000 (+0100)
Subject: Add missing modules to the API documentation
X-Git-Tag: 6.13.1~2^2
X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/9d61af1c25aa8a4e2236f196b6f64409e0984eb4?ds=inline

Add missing modules to the API documentation
---

diff --git a/README.rst b/README.rst
index d802c16..8f3aa29 100755
--- 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 61e9bbe..dc0aeb6 100755
--- 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 0dd05e9..893ed4e 100644
--- a/src/keypad.py
+++ b/src/keypad.py
@@ -467,7 +467,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 9e05c81..fda16cc 100755
--- 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 62698c8..b380dcb 100755
--- a/src/micropython.py
+++ b/src/micropython.py
@@ -1,6 +1,6 @@
 """
 `micropython` - MicroPython Specific Decorator Functions
-=================================================
+========================================================
 
 * Author(s): cefn
 """