Skip to content

Commit cac0491

Browse files
committed
Mock rp2pio imports and update todos in docs.
1 parent 2229b5e commit cac0491

File tree

3 files changed

+9
-14
lines changed

3 files changed

+9
-14
lines changed

README.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,23 @@ Dependencies
2929
This driver depends on:
3030

3131
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
32+
* `Adafruit CircuitPython PIOASM <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM>`_
3233

3334
Please ensure all dependencies are available on the CircuitPython filesystem.
3435
This is easily achieved by downloading
3536
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
3637
or individual libraries can be installed using
3738
`circup <https://github.com/adafruit/circup>`_.
3839

40+
Works with the Raspberry Pi RP2040 Pico family.
3941

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

4644
Installing from PyPI
4745
=====================
4846
.. note:: This library is not available on PyPI yet. Install documentation is included
4947
as a standard element. Stay tuned for PyPI availability!
5048

51-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
52-
5349
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
5450
PyPI <https://pypi.org/project/adafruit-circuitpython-pio-uart/>`_.
5551
To install for current user:
@@ -99,8 +95,10 @@ Or the following command to update an existing version:
9995
Usage Example
10096
=============
10197

102-
.. todo:: Add a quick, simple example. It and other examples should live in the
103-
examples folder and be included in docs/examples.rst.
98+
.. literalinclude:: ../examples/pio_uart_simpletest.py
99+
:caption: examples/pio_uart_simpletest.py
100+
:linenos:
101+
104102

105103
Documentation
106104
=============

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
# digitalio, micropython and busio. List the modules you use. Without it, the
2929
# autodoc module docs will fail to generate with a warning.
3030
# autodoc_mock_imports = ["digitalio", "busio"]
31+
autodoc_mock_imports = ["rp2pio"]
3132

3233
autodoc_preserve_defaults = True
3334

docs/index.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,10 @@ 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.
30+
Adafruit Raspberry Pi RP2040 Pico products <https://www.adafruit.com/category/875>
3531

3632
.. toctree::
3733
:caption: Other Links

0 commit comments

Comments
 (0)