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~1
X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/7e059ba8dc654418fee48d64e10de20bce3637d3

Add missing modules to API docs build.

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

Reviewed the docs build with:
sphinx-build -E -W -b html . _build/html
---

diff --git a/docs/conf.py b/docs/conf.py
index 8f25b4c..c51cebd 100755
--- 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", "RPi", "RPi.GPIO", "hid", "sysv_ipc"]
+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/pulseio.py b/src/pulseio.py
index 8d72abf..70e83dc 100644
--- a/src/pulseio.py
+++ b/src/pulseio.py
@@ -30,4 +30,4 @@ elif detector.board.greatfet_one:
 elif "sphinx" in sys.modules:
     pass
 else:
-    raise NotImplementedError("pulseio not supported for this board.")
\ No newline at end of file
+    raise NotImplementedError("pulseio not supported for this board.")