Doc tweaks to clarify external libraries, new boards and add HID library.

tannewt · tannewt · commit 1280e9122be4 · 2017-05-24T11:44:23.000-07:00
diff --git 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
@@ -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 <https://micropython.org>`_.
+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 <https://micropython.org>`_.
 
 .. _bundle_installation:
 
@@ -34,6 +35,14 @@ the ``lib/`` directory. Some drivers may not work without them.
     Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
     BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
 
+Helper Libraries
+-------
+
+These libraries build on top of the low level APIS to simplify common tasks.
+
+.. toctree::
+    USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
+
 Drivers
 -------
 
diff --git 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 <https://micropython.org>`_ for use on
 educational development boards designed and sold by `Adafruit
-<https://adafruit.com>`_ including the `Arduino Zero
+<https://adafruit.com>`_. 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 <https://www.adafruit.com/product/3333>`_,
+`Feather M0 Express <https://www.adafruit.com/product/3403>`_,
+and `Metro M0 Express <https://www.adafruit.com/product/3505>`_.
+Other supported boards include the `Arduino Zero
 <https://www.arduino.cc/en/Main/ArduinoBoardZero>`_, `Adafruit Feather M0 Basic
 <https://www.adafruit.com/product/2772>`_, `Adafruit Feather HUZZAH
 <https://www.adafruit.com/products/2821>`_ and `Adafruit Feather M0 Bluefruit LE
 <https://www.adafruit.com/products/2995>`_.
 
-Adafruit CircuitPython features unified Python hardware APIs available under
-`!shared-bindings` and a growing list of drivers that work with it.
-
 `Adafruit <https://adafruit.com>`_ has many excellent tutorials available
 through the `Adafruit Learning System <https://learn.adafruit.com/>`_. 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
@@ -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:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-# Adding `digitalio` support to other ports
	`1`	+# Adding ``*io`` support to other ports
`2`	`2`	`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.
`3`	`3`
`4`	`4`	These instructions also apply to `analogio`, `busio`, `pulseio` and `touchio`. Most drivers depend on `analogio`, `digitalio` and `busio` so start with those.