Make the docs build (locally at any rate)

adafruit · Nov 29, 2023 · 43ef2d3 · 43ef2d3
1 parent 91f7502
commit 43ef2d3
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 13 deletions.
diff --git a/README.rst b/README.rst
@@ -39,10 +39,8 @@ or individual libraries can be installed using
 
 
 
-.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
-image from the assets folder in the PCB's GitHub repo.
-
-`Purchase one from the Adafruit shop <http://www.adafruit.com/products/9999>`_
+.. ::
+    `Purchase one from the Adafruit shop <http://www.adafruit.com/products/9999>`_
 
 Installing from PyPI
 =====================

diff --git a/docs/conf.py b/docs/conf.py
@@ -27,7 +27,22 @@
 # 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 = ["digitalio", "busio"]
+autodoc_mock_imports = [
+    "bitmaptools",
+    "adafruit_aw9523",
+    "adafruit_lis3dh",
+    "displayio",
+    "espcamera",
+    "neopixel",
+    "sdcardio",
+    "storage",
+    "terminalio",
+    "adafruit_debouncer",
+    "adafruit_display_text",
+    "digitalio",
+    "busio",
+    "micropython",
+]
 
 autodoc_preserve_defaults = True
 

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -3,6 +3,6 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/pycamera_simpletest.py
-    :caption: examples/pycamera_simpletest.py
+.. literalinclude:: ../examples/camera/code.py
+    :caption: examples/camera/code.py
     :linenos:
diff --git a/docs/index.rst b/docs/index.rst
@@ -24,15 +24,9 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Other Links
 

diff --git a/requirements.txt b/requirements.txt
@@ -5,3 +5,4 @@
 
 Adafruit-Blinka
 adafruit-circuitpython-busdevice
+adafruit-circuitpython-aw9523