Skip to content

Commit 43ef2d3

Browse files
committed
Make the docs build (locally at any rate)
1 parent 91f7502 commit 43ef2d3

File tree

5 files changed

+21
-13
lines changed

5 files changed

+21
-13
lines changed

README.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,8 @@ or individual libraries can be installed using
3939

4040

4141

42-
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
43-
image from the assets folder in the PCB's GitHub repo.
44-
45-
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/9999>`_
42+
.. ::
43+
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/9999>`_
4644

4745
Installing from PyPI
4846
=====================

docs/conf.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,22 @@
2727
# Uncomment the below if you use native CircuitPython modules such as
2828
# digitalio, micropython and busio. List the modules you use. Without it, the
2929
# autodoc module docs will fail to generate with a warning.
30-
# autodoc_mock_imports = ["digitalio", "busio"]
30+
autodoc_mock_imports = [
31+
"bitmaptools",
32+
"adafruit_aw9523",
33+
"adafruit_lis3dh",
34+
"displayio",
35+
"espcamera",
36+
"neopixel",
37+
"sdcardio",
38+
"storage",
39+
"terminalio",
40+
"adafruit_debouncer",
41+
"adafruit_display_text",
42+
"digitalio",
43+
"busio",
44+
"micropython",
45+
]
3146

3247
autodoc_preserve_defaults = True
3348

docs/examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ Simple test
33

44
Ensure your device works with this simple test.
55

6-
.. literalinclude:: ../examples/pycamera_simpletest.py
7-
:caption: examples/pycamera_simpletest.py
6+
.. literalinclude:: ../examples/camera/code.py
7+
:caption: examples/camera/code.py
88
:linenos:

docs/index.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,9 @@ Table of Contents
2424
.. toctree::
2525
:caption: Tutorials
2626

27-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
28-
the toctree above for use later.
29-
3027
.. toctree::
3128
:caption: Related Products
3229

33-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
34-
the toctree above for use later.
35-
3630
.. toctree::
3731
:caption: Other Links
3832

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55

66
Adafruit-Blinka
77
adafruit-circuitpython-busdevice
8+
adafruit-circuitpython-aw9523

0 commit comments

Comments
 (0)