djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a micropython section and edit drivers doc

Browse Source
This commit is contained in:
Carol Willing 2017-09-02 08:37:14 -05:00 committed by Scott Shawcroft
parent 676a5b399e
commit 1f71851d3a
2 changed files with 55 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/drivers.rst
View File

@ -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 <https://github.com/adafruit/Adafruit_Circu
To install them:
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_ and unzip the latest zip thats not a source zip.
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_
and unzip the latest zip that's not a source zip.
#. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``.
Foundational Libraries
@ -36,11 +39,12 @@ the ``lib/`` directory. Some drivers may not work without them.
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
@ -50,6 +54,7 @@ Drivers provide easy access to sensors and other chips without requiring a
knowledge of the interface details of the chip itself.
.. toctree::
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
RGB Displays <http://micropython-rgb.readthedocs.io/>

17
index.rst
View File

@ -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 <https://adafruit.com>`_ has many
excellent tutorials available through the
`Adafruit Learning System <https://learn.adafruit.com/>`_.
@ -26,11 +26,11 @@ excellent tutorials available through the
What is CircuitPython?
----------------------
**CircuitPython** is an open source derivative of
`MicroPython <https://micropython.org>`_ for use on educational development
boards designed and sold by `Adafruit <https://adafruit.com>`_. 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 <https://micropython.org>`_. CircuitPython supports use on
educational development boards designed and sold by
`Adafruit <https://adafruit.com>`_. Adafruit CircuitPython features unified
Python core APIs and a growing list of drivers of that work with it.
What boards use CircuitPython?
------------------------------
@ -69,6 +69,11 @@ Full Table of Contents
docs/design_guide
docs/common_hal
.. toctree::
:maxdepth: 3
:caption: MicroPython specific docs
docs/library/index.rst
.. toctree::