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 8f25b4c42f10fc433ad16ceb4c2b78c23f49e44b..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.
 # 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),
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3.4", None),

diff --git a/src/pulseio.py b/src/pulseio.py
index 8d72abfb19d1a6d23746882791aa07765fea91e7..70e83dc805dbb621d997964e8e1fcde727a2edee 100644 (file)
--- a/src/pulseio.py
+++ b/src/pulseio.py
@@ -30,4 +30,4 @@ elif detector.board.greatfet_one:
 elif "sphinx" in sys.modules:
     pass
 else:
 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.")