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 24db28b576cbd5c7ff2b51e3f24ee6315f52a763..3522ed49121f490aa843abe8a9a7585b2e1e9813 100755 (executable)
--- 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
 
     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:
 
 
 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:: digitalio
   :members:

+
+.. automodule:: analogio
+  :members:
+
+.. automodule:: pulseio
+  :members:
+
+.. automodule:: neopixel_write
+  :members:
+
+

diff --git a/docs/conf.py b/docs/conf.py
index cadf23f9d371f9e9c96c30577e3f90d0f6f00eaa..8f25b4c42f10fc433ad16ceb4c2b78c23f49e44b 100755 (executable)
--- 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.
 # 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),
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3.4", None),

diff --git a/src/analogio.py b/src/analogio.py
index f126ef326b9d146d5f5d720a34e26ecca888b8c9..328ee84e528b55f857e94516d927fa28e7121e7f 100644 (file)
--- a/src/analogio.py
+++ b/src/analogio.py
@@ -1,11 +1,14 @@
 """
 `analogio` - Analog input and output control
 """
 `analogio` - Analog input and output control

-=================================================
+============================================

 See `CircuitPython:analogio` in CircuitPython for more details.
 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
 * Author(s): Carter Nelson, Melissa LeBlanc-Williams
 """
 
 from adafruit_blinka.agnostic import detector

+import sys

 
 # pylint: disable=ungrouped-imports,wrong-import-position,unused-import
 
 
 # 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
     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.")
 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.
 
 
 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
 """
 `neopixel_write` - NeoPixel precision timed writing support

-=================================================
+===========================================================

 
 See `CircuitPython:neopixel_write` in CircuitPython for more details.
 
 See `CircuitPython:neopixel_write` in CircuitPython for more details.

+Currently supported on Raspberry Pi only.

 
 * Author(s): ladyada
 """
 
 * Author(s): ladyada
 """

diff --git a/src/pulseio.py b/src/pulseio.py
index 7c53457a9c223bd7b6f4a24fb25ccaebd3ff3f3c..8d72abfb19d1a6d23746882791aa07765fea91e7 100644 (file)
--- 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.
 See `CircuitPython:pulseio` in CircuitPython for more details.

+Not supported by all boards.
+

 * Author(s): Melissa LeBlanc-Williams
 """
 
 from adafruit_blinka.agnostic import detector
 * 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
 
 # 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
     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
     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
     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
     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
     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
     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