Merge pull request #373 from scottamain/docs

Add missing modules to API docs build.

diff --git a/README.rst b/README.rst
index 2f2b7134db874f91b586fba837ea2a6311f1188f..40df1a97b8ed2197ea54b64aa0a611136aa30b58 100755 (executable)
--- a/README.rst
+++ b/README.rst
@@ -26,8 +26,10 @@ on hosts running micropython. Working code exists to emulate the CircuitPython p
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
 * **bitbangio** - software-driven interfaces for I2C, SPI
 * **busio** - hardware-driven interfaces for I2C, SPI, UART
-* **time** * - substitute functions monkey-patched to time module
+* **pulseio** - contains classes that provide access to basic pulse IO (PWM)
 
+For details, see the `Blinka API reference
+<https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.
 
 Dependencies
 =============
@@ -97,7 +99,7 @@ install dependencies (feel free to reuse the virtual environment from above):
 
     python3 -m venv .env
     source .env/bin/activate
-    pip install Sphinx sphinx-rtd-theme
+    pip install Sphinx sphinx-rtd-theme Adafruit-PlatformDetect
 
 Now, once you have the virtual environment activated:
 

diff --git a/docs/api.rst b/docs/api.rst
index 66bca16197c56cba3c0d2b6c4d56710261d609a8..61e9bbee5fc477d73425faa0a99dea71c333b0fb 100755 (executable)
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -24,3 +24,14 @@
 
 .. automodule:: digitalio
   :members:
+
+.. automodule:: analogio
+  :members:
+
+.. automodule:: pulseio
+  :members:
+
+.. automodule:: neopixel_write
+  :members:
+
+

diff --git a/docs/conf.py b/docs/conf.py
index cadf23f9d371f9e9c96c30577e3f90d0f6f00eaa..c51cebd0e72a7ac62e9f4e192aa42daeb6f4ecf5 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -19,7 +19,14 @@ extensions = [
 # 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 = ["machine", "Adafruit_GPIO"]
+autodoc_mock_imports = [
+    "machine",
+    "Adafruit_GPIO",
+    "RPi",
+    "RPi.GPIO",
+    "hid",
+    "sysv_ipc",
+]
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3.4", None),

diff --git a/src/analogio.py b/src/analogio.py
index f126ef326b9d146d5f5d720a34e26ecca888b8c9..97323e48dbab9b11cad8f930648c4cb5670bda0c 100644 (file)
--- a/src/analogio.py
+++ b/src/analogio.py
@@ -1,10 +1,14 @@
 """
 `analogio` - Analog input and output control
-=================================================
+============================================
 See `CircuitPython:analogio` in CircuitPython for more details.
+Not supported by all boards.
+
 * Author(s): Carter Nelson, Melissa LeBlanc-Williams
 """
 
+import sys
+
 from adafruit_blinka.agnostic import detector
 
 # pylint: disable=ungrouped-imports,wrong-import-position,unused-import
@@ -17,5 +21,7 @@ elif detector.board.greatfet_one:
     from adafruit_blinka.microcontroller.nxp_lpc4330.analogio import AnalogOut
 elif detector.chip.RK3308:
     from adafruit_blinka.microcontroller.generic_linux.sysfs_analogin import AnalogIn
+elif "sphinx" in sys.modules:
+    pass
 else:
     raise NotImplementedError("analogio not supported for this board.")

diff --git a/src/digitalio.py b/src/digitalio.py
index 080abbf2c008bfd3507395d5863d913215f4c8f5..cdc9e33cca5831aef9d2bc9f9fbf9da27f871fca 100755 (executable)
--- a/src/digitalio.py
+++ b/src/digitalio.py
@@ -1,6 +1,6 @@
 """
-`digitalio` - Digital input and output control
-=================================================
+`digitalio` - Digital input and output control (GPIO)
+=====================================================
 
 See `CircuitPython:digitalio` in CircuitPython for more details.
 

diff --git a/src/neopixel_write.py b/src/neopixel_write.py
index 5626bc632bace3df0884ecfad19edc8c210310f5..2c85f0166ff1b79555e6127563b6c7f78155bb16 100644 (file)
--- a/src/neopixel_write.py
+++ b/src/neopixel_write.py
@@ -1,8 +1,9 @@
 """
 `neopixel_write` - NeoPixel precision timed writing support
-=================================================
+===========================================================
 
 See `CircuitPython:neopixel_write` in CircuitPython for more details.
+Currently supported on Raspberry Pi only.
 
 * Author(s): ladyada
 """

diff --git a/src/pulseio.py b/src/pulseio.py
index 7c53457a9c223bd7b6f4a24fb25ccaebd3ff3f3c..848ff1400bb3a985814a1f5bbdea68e580813c18 100644 (file)
--- a/src/pulseio.py
+++ b/src/pulseio.py
@@ -1,10 +1,14 @@
 """
-`pulseio` - Pulse Width Modulation Input and Output control
-=================================================
+`pulseio` - Pulse Width Modulation input and output control
+===========================================================
 See `CircuitPython:pulseio` in CircuitPython for more details.
+Not supported by all boards.
+
 * Author(s): Melissa LeBlanc-Williams
 """
 
+import sys
+
 from adafruit_blinka.agnostic import detector
 
 # pylint: disable=unused-import
@@ -12,15 +16,19 @@ from adafruit_blinka.agnostic import detector
 if detector.board.any_raspberry_pi:
     from adafruit_blinka.microcontroller.bcm283x.pulseio.PulseIn import PulseIn
     from adafruit_blinka.microcontroller.bcm283x.pulseio.PWMOut import PWMOut
-if detector.board.any_coral_board:
+elif detector.board.any_coral_board:
     from adafruit_blinka.microcontroller.generic_linux.sysfs_pwmout import PWMOut
-if detector.board.any_giant_board:
+elif detector.board.any_giant_board:
     from adafruit_blinka.microcontroller.generic_linux.sysfs_pwmout import PWMOut
-if detector.board.any_beaglebone:
+elif detector.board.any_beaglebone:
     from adafruit_blinka.microcontroller.am335x.sysfs_pwmout import PWMOut
-if detector.board.any_rock_pi_board:
+elif detector.board.any_rock_pi_board:
     from adafruit_blinka.microcontroller.generic_linux.sysfs_pwmout import PWMOut
-if detector.board.binho_nova:
+elif detector.board.binho_nova:
     from adafruit_blinka.microcontroller.nova.pwmout import PWMOut
-if detector.board.greatfet_one:
+elif detector.board.greatfet_one:
     from adafruit_blinka.microcontroller.nxp_lpc4330.pwmout import PWMOut
+elif "sphinx" in sys.modules:
+    pass
+else:
+    raise NotImplementedError("pulseio not supported for this board.")