diff --git a/docs/drivers.rst b/docs/drivers.rst index 4a542e4d7b..6b04bdbc07 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -1,5 +1,7 @@ -Additional Libraries on GitHub -======================================== +.. _adafruit-libndrivers: + +Additional Adafruit Libraries and Drivers on GitHub +=================================================== These are libraries and drivers available in separate GitHub repos. They are designed for use with CircuitPython and may or may not work with @@ -20,7 +22,8 @@ The bundles are available `on GitHub `_ and unzip the latest zip thats not a source zip. +#. `Download `_ + and unzip the latest zip that's not a source zip. #. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``. Foundational Libraries @@ -32,16 +35,17 @@ the ``lib/`` directory. Some drivers may not work without them. .. toctree:: - Register Library - BusDevice Library + 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) + + USB Human Interface Device (Keyboard and Mouse) Drivers ------- @@ -50,17 +54,18 @@ Drivers provide easy access to sensors and other chips without requiring a knowledge of the interface details of the chip itself. .. toctree:: - NeoPixel - SimpleIO - RGB Displays - SD Card - Analog-to-digital converters: ADS1015 and ADS1115 - DS3231 Real-time Clock (Precision RTC) - DS1307 Real-time Clock (5V RTC Breakout) - PCF8523 Real-time Clock (Adalogger RTC) - TCS34725 Color Sensor - TSL2561 Light Sensor - PCA9685 Motor and Servo Controllers - HT16K33 LED Matrices and Segment Displays - IS31FL3731 Charlieplexed LED Matrix - MAX7219 LED Matrix + + NeoPixel + SimpleIO + RGB Displays + SD Card + Analog-to-digital converters: ADS1015 and ADS1115 + DS3231 Real-time Clock (Precision RTC) + DS1307 Real-time Clock (5V RTC Breakout) + PCF8523 Real-time Clock (Adalogger RTC) + TCS34725 Color Sensor + TSL2561 Light Sensor + PCA9685 Motor and Servo Controllers + HT16K33 LED Matrices and Segment Displays + IS31FL3731 Charlieplexed LED Matrix + MAX7219 LED Matrix diff --git a/index.rst b/index.rst index 71efdddb47..cd10a3d3eb 100644 --- a/index.rst +++ b/index.rst @@ -18,7 +18,7 @@ Adafruit CircuitPython API Reference :alt: Discord Welcome to the API reference documentation for Adafruit CircuitPython. -This contains low-level API docs, and these docs may link out to separate +This contains low-level API reference docs which may link out to separate *"getting started"* guides. `Adafruit `_ has many excellent tutorials available through the `Adafruit Learning System `_. @@ -26,11 +26,11 @@ excellent tutorials available through the 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. +**CircuitPython** is an *education friendly* open source derivative of +`MicroPython `_. CircuitPython supports 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 it. What boards use CircuitPython? ------------------------------ @@ -46,7 +46,7 @@ Other supported boards include: * `Arduino Zero `_ * `Adafruit Feather M0 Basic `_ -* `Adafruit Feather HUZZAH `_ +* `Adafruit Feather HUZZAH `_ * `Adafruit Feather M0 Bluefruit LE `_ .. _contents: @@ -55,30 +55,35 @@ Full Table of Contents ---------------------- .. toctree:: - :maxdepth: 3 - :caption: API and Usage + :maxdepth: 3 + :caption: API and Usage - shared-bindings/index.rst - docs/supported_ports.rst - docs/troubleshooting.rst - docs/drivers.rst + shared-bindings/index.rst + docs/supported_ports.rst + docs/troubleshooting.rst + docs/drivers.rst .. toctree:: - :maxdepth: 3 - :caption: Developer reference + :maxdepth: 3 + :caption: Developer reference - docs/design_guide - docs/common_hal - docs/library/index.rst + docs/design_guide + docs/common_hal .. toctree:: - :maxdepth: 3 - :caption: About the project + :maxdepth: 3 + :caption: MicroPython specific docs - README - CONTRIBUTING - CODE_OF_CONDUCT - license.rst + docs/library/index.rst + +.. toctree:: + :maxdepth: 3 + :caption: About the project + + README + CONTRIBUTING + CODE_OF_CONDUCT + license.rst Indices and tables ==================