From: Scott Main <smain@google.com>
Date: Sun, 6 Dec 2020 06:17:17 +0000 (-0800)
Subject: Add missing modules to API docs build.
X-Git-Tag: 5.9.0~1^2~3
X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/85132dc280419340e3c774c29b286e74ea191598?ds=sidebyside

Add missing modules to API docs build.

Includes tweaks to Sphinx config and module files to help the docs build.
---

diff --git a/README.rst b/README.rst
index 24db28b..3522ed4 100755
--- a/README.rst
+++ b/README.rst
@@ -97,7 +97,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 66bca16..61e9bbe 100755
--- 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 cadf23f..8f25b4c 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -19,7 +19,7 @@ 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 f126ef3..328ee84 100644
--- a/src/analogio.py
+++ b/src/analogio.py
@@ -1,11 +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
 """
 
 from adafruit_blinka.agnostic import detector
+import sys
 
 # pylint: disable=ungrouped-imports,wrong-import-position,unused-import
 
@@ -17,5 +20,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 080abbf..cdc9e33 100755
--- 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 5626bc6..2c85f01 100644
--- 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 7c53457..8d72abf 100644
--- a/src/pulseio.py
+++ b/src/pulseio.py
@@ -1,26 +1,33 @@
 """
-`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
 """
 
 from adafruit_blinka.agnostic import detector
+import sys
 
 # pylint: disable=unused-import
 
 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.")
\ No newline at end of file