From 676a5b399e989757d4b45110b68604245ddc5558 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 2 Sep 2017 08:30:29 -0500 Subject: [PATCH] Structure contents to be user facing --- index.rst | 63 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 45 insertions(+), 18 deletions(-) diff --git a/index.rst b/index.rst index 9a0096aa4d..71efdddb47 100644 --- a/index.rst +++ b/index.rst @@ -1,5 +1,5 @@ Adafruit CircuitPython API Reference -======================================== +==================================== .. image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master :target: https://travis-ci.org/adafruit/circuitpython @@ -17,37 +17,64 @@ Adafruit CircuitPython API Reference :target: https://adafru.it/discord :alt: Discord -Welcome! This is the documentation for Adafruit CircuitPython. It is an open -source derivative of `MicroPython `_ for use on -educational development boards designed and sold by `Adafruit -`_. Adafruit CircuitPython features unified Python core -APIs and a growing list of drivers that work with it. +Welcome to the API reference documentation for Adafruit CircuitPython. +This contains low-level API docs, and these docs may link out to separate +*"getting started"* guides. `Adafruit `_ has many +excellent tutorials available through the +`Adafruit Learning System `_. + +What is CircuitPython? +---------------------- + +**CircuitPython** is an open source derivative of +`MicroPython `_ for use on educational development +boards designed and sold by `Adafruit `_. Adafruit +CircuitPython features unified Python core APIs and a growing list of drivers +of that work with CircuitPython. + +What boards use CircuitPython? +------------------------------ The Adafruit Express line of boards are specifically -designed for use with CircuitPython. They are the -`CircuitPlayground Express `_, -`Feather M0 Express `_, -and `Metro M0 Express `_. -Other supported boards include the `Arduino Zero -`_, `Adafruit Feather M0 Basic -`_, `Adafruit Feather HUZZAH -`_ and `Adafruit Feather M0 Bluefruit LE -`_. +designed for use with CircuitPython. This line includes: -`Adafruit `_ has many excellent tutorials available -through the `Adafruit Learning System `_. These -docs are low-level API docs and may link out to separate getting started guides. +* `CircuitPlayground Express `_ +* `Feather M0 Express `_ +* `Metro M0 Express `_ + +Other supported boards include: + +* `Arduino Zero `_ +* `Adafruit Feather M0 Basic `_ +* `Adafruit Feather HUZZAH `_ +* `Adafruit Feather M0 Bluefruit LE `_ + +.. _contents: + +Full Table of Contents +---------------------- .. toctree:: :maxdepth: 3 + :caption: API and Usage shared-bindings/index.rst docs/supported_ports.rst docs/troubleshooting.rst docs/drivers.rst + +.. toctree:: + :maxdepth: 3 + :caption: Developer reference + docs/design_guide docs/common_hal docs/library/index.rst + +.. toctree:: + :maxdepth: 3 + :caption: About the project + README CONTRIBUTING CODE_OF_CONDUCT