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

92 lines
2.7 KiB
ReStructuredText
Raw Normal View History

Rename to CircuitPython
2016-12-20 14:20:08 -05:00
Adafruit CircuitPython API Reference
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
====================================
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
Add Gitter integration to Travis and add badges to the docs.
2017-01-06 13:59:20 -05:00
.. image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master
:target: https://travis-ci.org/adafruit/circuitpython
:alt: Build Status
.. image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
:target: http://circuitpython.readthedocs.io/
:alt: Doc Status
.. image:: https://badges.gitter.im/adafruit/circuitpython.svg
:target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
:alt: Gitter
Turn on Rosie CI testing to test new builds on real hardware. This introduces a skip_if module that can be used by tests to determine when they should be skipped due to the environment. Some tests have been split in order to have finer grained skip control.
2017-07-03 18:05:08 -04:00
.. image :: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
Welcome to the API reference documentation for Adafruit CircuitPython.
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
This contains low-level API reference docs which may link out to separate
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
excellent tutorials available through the
`Adafruit Learning System <https://learn.adafruit.com/>`_.
What is CircuitPython?
----------------------
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
**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.
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
What boards use CircuitPython?
------------------------------
Doc tweaks to clarify external libraries, new boards and add HID library.
2017-05-24 14:44:23 -04:00
The Adafruit Express line of boards are specifically
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
designed for use with CircuitPython. This line includes:
collapse board listings
2017-09-02 10:20:21 -04:00
* `CircuitPlayground Express <https://www.adafruit.com/product/3333>`_,
* `Feather M0 Express <https://www.adafruit.com/product/3403>`_, and
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
* `Metro M0 Express <https://www.adafruit.com/product/3505>`_
Other supported boards include:
collapse board listings
2017-09-02 10:20:21 -04:00
* `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>`_.
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
.. _contents:
Full Table of Contents
----------------------
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
.. toctree::
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
:maxdepth: 3
:caption: API and Usage
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
shared-bindings/index.rst
docs/supported_ports.rst
docs/troubleshooting.rst
docs/drivers.rst
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
.. toctree::
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
:maxdepth: 3
:caption: Developer reference
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
docs/design_guide
docs/common_hal
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
.. toctree::
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
:maxdepth: 3
:caption: MicroPython specific docs
Structure contents to be user facing
2017-09-02 09:30:29 -04:00
Add a micropython section and edit drivers doc
2017-09-02 09:37:14 -04:00
docs/library/index.rst
.. toctree::
:maxdepth: 3
:caption: About the project
README
CONTRIBUTING
CODE_OF_CONDUCT
license.rst
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`