8000 docs: Add module support matrix. · sparkfun/circuitpython@c5e515b · GitHub
[go: up one dir, main page]

Skip to content

Commit c5e515b

Browse files
committed
docs: Add module support matrix.
1 parent 2ecb9a3 commit c5e515b

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

index.rst

Lines changed: 1 addition & 1 d 8000 eletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ through the `Adafruit Learning System <https://learn.adafruit.com/>`_. These
3535
docs are low-level API docs and may link out to separate getting started guides.
3636

3737
.. toctree::
38-
:maxdepth: 2
38+
:maxdepth: 3
3939

4040
shared-bindings/index.rst
4141
docs/drivers.rst

shared-bindings/index.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,23 @@ Core Modules
33

44
These core modules are intended on being consistent across ports. Currently
55
they are only implemented in the SAMD21 and ESP8266 ports. A module may not exist
6-
in a port if no underlying hardware support is present. For example, a
7-
microcontroller without analog features will not have `analogio`.
6+
in a port if no underlying hardware support is present or if flash space is
7+
limited. For example, a microcontroller without analog features will not have
8+
`analogio`.
9+
10+
Support Matrix
11+
---------------
12+
13+
=============== ========== ========= =========== ======= ======= =========== ================= ================ ========= ======== ========= ======= =========
14+
Port `analogio` `audioio` `bitbangio` `board` `busio` `digitalio` `microcontroller` `neopixel_write` `pulseio` `time` `touchio` `uheap` `usb_hid`
15+
=============== ========== ========= =========== ======= ======= =========== ================= ================ ========= ======== ========= ======= =========
16+
SAMD21 **Yes** No No **Yes** **Yes** **Yes** **Yes** **Yes** No **Yes** **Yes** Debug **Yes**
17+
SAMD21 Express **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** Debug **Yes**
18+
ESP8266 **Yes** No **Yes** **Yes** **Yes** **Yes** **Yes** **Yes** No **Yes** No Debug No
19+
=============== ========== ========= =========== ======= ======= =========== ================= ================ ========= ======== ========= ======= =========
20+
21+
Modules
22+
---------
823

924
.. toctree::
1025
:glob:

0 commit comments

Comments
 (0)
0