From 1280e9122be4e0986b5cd4914a8158f2a0b69c9c Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Wed, 24 May 2017 11:44:23 -0700 Subject: [PATCH] Doc tweaks to clarify external libraries, new boards and add HID library. --- docs/common_hal.md | 2 +- docs/drivers.rst | 15 ++++++++++++--- index.rst | 15 ++++++++++----- shared-bindings/index.rst | 9 +++++---- 4 files changed, 28 insertions(+), 13 deletions(-) diff --git a/docs/common_hal.md b/docs/common_hal.md index 22093c3baa..ee2105ba14 100644 --- a/docs/common_hal.md +++ b/docs/common_hal.md @@ -1,4 +1,4 @@ -# Adding `digitalio` support to other ports +# Adding ``*io`` support to other ports `digitalio` provides a well-defined, cross-port hardware abstraction layer built to support different devices and their drivers. It's backed by the Common HAL, a C api suitable for supporting different hardware in a similar manner. By sharing this C api, developers can support new hardware easily and cross-port functionality to the new hardware. These instructions also apply to `analogio`, `busio`, `pulseio` and `touchio`. Most drivers depend on `analogio`, `digitalio` and `busio` so start with those. diff --git a/docs/drivers.rst b/docs/drivers.rst index 191f6f8c34..ccd154a510 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -1,8 +1,9 @@ -Adafruit CircuitPython drivers +Additional Libraries on GitHub ======================================== -These are drivers available in separate GitHub repos. They are designed for use -with CircuitPython and may or may not work with `MicroPython `_. +These are libraries and drivers available in separate GitHub repos. They are +designed for use with CircuitPython and may or may not work with +`MicroPython `_. .. _bundle_installation: @@ -34,6 +35,14 @@ the ``lib/`` directory. Some drivers may not work without them. Register Library BusDevice Library +Helper Libraries +------- + +These libraries build on top of the low level APIS to simplify common tasks. + +.. toctree:: + USB Human Interface Device (Keyboard and Mouse) + Drivers ------- diff --git a/index.rst b/index.rst index b20bc7bfeb..be84928cec 100644 --- a/index.rst +++ b/index.rst @@ -16,15 +16,20 @@ Adafruit CircuitPython API Reference 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 -`_ including the `Arduino Zero +`_. Adafruit CircuitPython features unified Python core +APIs and a growing list of drivers that work with it. + +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 `_. -Adafruit CircuitPython features unified Python hardware APIs available under -`!shared-bindings` and a growing list of drivers that work with it. - `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. @@ -33,9 +38,9 @@ docs are low-level API docs and may link out to separate getting started guides. :maxdepth: 2 shared-bindings/index.rst + docs/drivers.rst docs/common_hal docs/design_guide - docs/drivers.rst docs/supported_ports.rst docs/library/index.rst README diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst index ebea3c16a0..2448a7820a 100644 --- a/shared-bindings/index.rst +++ b/shared-bindings/index.rst @@ -1,9 +1,10 @@ -Shared Libraries +Core Modules ======================================== -These core libraries are intended on being consistent across ports. Currently -they are only implemented in the SAMD21 port but the ESP8266 support will soon -follow. +These core modules are intended on being consistent across ports. Currently +they are only implemented in the SAMD21 and ESP8266 ports. A module may not exist +in a port if no underlying hardware support is present. For example, a +microcontroller without analog features will not have `analogio`. .. toctree:: :glob: