Skip to content

Commit 676a5b3

Browse files
willingctannewt
authored andcommitted
Structure contents to be user facing
1 parent 6d9d683 commit 676a5b3

File tree

1 file changed

+46
-19
lines changed

1 file changed

+46
-19
lines changed

index.rst

Lines changed: 46 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Adafruit CircuitPython API Reference
2-
========================================
2+
====================================
33

44
.. image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master
55
:target: https://travis-ci.org/adafruit/circuitpython
@@ -17,37 +17,64 @@ Adafruit CircuitPython API Reference
1717
:target: https://adafru.it/discord
1818
:alt: Discord
1919
20-
Welcome! This is the documentation for Adafruit CircuitPython. It is an open
21-
source derivative of `MicroPython <https://micropython.org>`_ for use on
22-
educational development boards designed and sold by `Adafruit
23-
<https://adafruit.com>`_. Adafruit CircuitPython features unified Python core
24-
APIs and a growing list of drivers that work with it.
20+
Welcome to the API reference documentation for Adafruit CircuitPython.
21+
This contains low-level API docs, and these docs may link out to separate
22+
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
23+
excellent tutorials available through the
24+
`Adafruit Learning System <https://learn.adafruit.com/>`_.
25+
26+
What is CircuitPython?
27+
----------------------
28+
29+
**CircuitPython** is an open source derivative of
30+
`MicroPython <https://micropython.org>`_ for use on educational development
31+
boards designed and sold by `Adafruit <https://adafruit.com>`_. Adafruit
32+
CircuitPython features unified Python core APIs and a growing list of drivers
33+
of that work with CircuitPython.
34+
35+
What boards use CircuitPython?
36+
------------------------------
2537

2638
The Adafruit Express line of boards are specifically
27-
designed for use with CircuitPython. They are the
28-
`CircuitPlayground Express <https://www.adafruit.com/product/3333>`_,
29-
`Feather M0 Express <https://www.adafruit.com/product/3403>`_,
30-
and `Metro M0 Express <https://www.adafruit.com/product/3505>`_.
31-
Other supported boards include the `Arduino Zero
32-
<https://www.arduino.cc/en/Main/ArduinoBoardZero>`_, `Adafruit Feather M0 Basic
33-
<https://www.adafruit.com/product/2772>`_, `Adafruit Feather HUZZAH
34-
<https://www.adafruit.com/products/2821>`_ and `Adafruit Feather M0 Bluefruit LE
35-
<https://www.adafruit.com/products/2995>`_.
36-
37-
`Adafruit <https://adafruit.com>`_ has many excellent tutorials available
38-
through the `Adafruit Learning System <https://learn.adafruit.com/>`_. These
39-
docs are low-level API docs and may link out to separate getting started guides.
39+
designed for use with CircuitPython. This line includes:
40+
41+
* `CircuitPlayground Express <https://www.adafruit.com/product/3333>`_
42+
* `Feather M0 Express <https://www.adafruit.com/product/3403>`_
43+
* `Metro M0 Express <https://www.adafruit.com/product/3505>`_
44+
45+
Other supported boards include:
46+
47+
* `Arduino Zero <https://www.arduino.cc/en/Main/ArduinoBoardZero>`_
48+
* `Adafruit Feather M0 Basic <https://www.adafruit.com/product/2772>`_
49+
* `Adafruit Feather HUZZAH <https://www.adafruit.com/products/2821>`_
50+
* `Adafruit Feather M0 Bluefruit LE <https://www.adafruit.com/products/2995>`_
51+
52+
.. _contents:
53+
54+
Full Table of Contents
55+
----------------------
4056

4157
.. toctree::
4258
:maxdepth: 3
59+
:caption: API and Usage
4360

4461
shared-bindings/index.rst
4562
docs/supported_ports.rst
4663
docs/troubleshooting.rst
4764
docs/drivers.rst
65+
66+
.. toctree::
67+
:maxdepth: 3
68+
:caption: Developer reference
69+
4870
docs/design_guide
4971
docs/common_hal
5072
docs/library/index.rst
73+
74+
.. toctree::
75+
:maxdepth: 3
76+
:caption: About the project
77+
5178
README
5279
CONTRIBUTING
5380
CODE_OF_CONDUCT

0 commit comments

Comments
 (0)