summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 6dadddfc1a258f6567b4ba05fc2ddd0116830026 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Adafruit CircuitPython API Reference
====================================

Welcome to the API reference documentation for Adafruit CircuitPython.
This contains low-level API reference docs which may link out to separate
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
excellent tutorials available through the
`Adafruit Learning System <https://learn.adafruit.com/>`_.

.. include:: ../README.rst

.. _contents:

Full Table of Contents
----------------------

.. toctree::
   :maxdepth: 3
   :caption: API and Usage

   ../shared-bindings/index.rst
   supported_ports.rst
   troubleshooting.rst
   drivers.rst

.. toctree::
   :maxdepth: 1
   :caption: Design and porting reference

   design_guide
   porting
   common_hal

.. toctree::
   :maxdepth: 2
   :caption: MicroPython specific

   library/index.rst

.. toctree::
   :maxdepth: 1
   :caption: About the project

   ../README
   ../CONTRIBUTING
   ../BUILDING
   ../CODE_OF_CONDUCT
   ../license.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`