8000 Add a micropython section and edit drivers doc · sparkfun/circuitpython@1f71851 · GitHub
[go: up one dir, main page]

Skip to content

Commit 1f71851

Browse files
willingctannewt
authored andcommitted
Add a micropython section and edit drivers doc
1 parent 676a5b3 commit 1f71851

File tree

2 files changed

+55
-45
lines changed

2 files changed

+55
-45
lines changed

docs/drivers.rst

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Additional Libraries on GitHub
2-
========================================
1+
.. _adafruit-libndrivers:
2+
3+
Additional Adafruit Libraries and Drivers on GitHub
4+
===================================================
35

46
These are libraries and drivers available in separate GitHub repos. They are
57
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
2022

2123
To install them:
2224

23-
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_ and unzip the latest zip thats not a source zip.
25+
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_
26+
and unzip the latest zip that's not a source zip.
2427
#. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``.
2528

2629
Foundational Libraries
@@ -32,16 +35,17 @@ the ``lib/`` directory. Some drivers may not work without them.
3235

3336
.. toctree::
3437

35-
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
36-
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
38+
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
39+
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
3740

3841
Helper Libraries
39-
-------
42+
----------------
4043

4144
These libraries build on top of the low level APIs to simplify common tasks.
4245

4346
.. toctree::
44-
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
47+
48+
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
4549

4650
Drivers
4751
-------
@@ -50,17 +54,18 @@ Drivers provide easy access to sensors and other chips without requiring a
5054
knowledge of the interface details of the chip itself.
5155

5256
.. toctree::
53-
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
54-
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
55-
RGB Displays <http://micropython-rgb.readthedocs.io/>
56-
SD Card <https://circuitpython.readthedocs.io/projects/sdcard/en/latest/>
57-
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
58-
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
59-
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
60-
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
61-
TCS34725 Color Sensor <http://micropython-tcs34725.readthedocs.io/>
62-
TSL2561 Light Sensor <http://micropython-tsl2561.readthedocs.io/>
63-
PCA9685 Motor and Servo Controllers <http://micropython-pca9685.readthedocs.io/>
64-
HT16K33 LED Matrices and Segment Displays <http://micropython-ht16k33.readthedocs.io/>
65-
IS31FL3731 Charlieplexed LED Matrix <http://micropython-is31fl3731.readthedocs.io/>
66-
MAX7219 LED Matrix <http://micropython-max7219.readthedocs.io/>
57+
58+
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
59+
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
60+
RGB Displays <http://micropython-rgb.readthedocs.io/>
61+
SD Card <https://circuitpython.readthedocs.io/projects/sdcard/en/latest/>
62+
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
63+
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
64+
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
65+
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
66+
TCS34725 Color Sensor <http://micropython-tcs34725.readthedocs.io/>
67+
TSL2561 Light Sensor <http://micropython-tsl2561.readthedocs.io/>
68+
PCA9685 Motor and Servo Controllers <http://micropython-pca9685.readthedocs.io/>
69+
HT16K33 LED Matrices and Segment Displays <http://micropython-ht16k33.readthedocs.io/>
70+
IS31FL3731 Charlieplexed LED Matrix <http://micropython-is31fl3731.readthedocs.io/>
71+
MAX7219 LED Matrix <http://micropython-max7219.readthedocs.io/>

index.rst

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ Adafruit CircuitPython API Reference
1818
:alt: Discord
1919
2020
Welcome to the API reference documentation for Adafruit CircuitPython.
21-
This contains low-level API docs, and these docs may link out to separate
21+
This contains low-level API reference docs which may link out to separate
2222
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
2323
excellent tutorials available through the
2424
`Adafruit Learning System <https://learn.adafruit.com/>`_.
2525

2626
What is CircuitPython?
2727
----------------------
2828

29-
**CircuitPython** is an open source derivative of
30-
`MicroPython <https://micropython.org>`_ for use on educational development
31-
boards designed and sold by `Adafruit <https://adafruit.com>`_. Adafruit
32-
CircuitPython features unified Python core APIs and a growing list of drivers
33-
of that work with CircuitPython.
29+
**CircuitPython** is an *education friendly* open source derivative of
30+
`MicroPython <https://micropython.org>`_. CircuitPython supports use on
31+
educational development boards designed and sold by
32+
`Adafruit <https://adafruit.com>`_. Adafruit CircuitPython features unified
33+
Python core APIs and a growing list of drivers of that work with it.
3434

3535
What boards use CircuitPython?
3636
------------------------------
@@ -46,7 +46,7 @@ Other supported boards include:
4646

4747
* `Arduino Zero <https://www.arduino.cc/en/Main/ArduinoBoardZero>`_
4848
* `Adafruit Feather M0 Basic <https://www.adafruit.com/product/2772>`_
49-
* `Adafruit Feather HUZZAH <https://www.adafruit.com/products/2821>`_
49+
* `Adafruit Feather HUZZAH <https://www.adafruit.com/products/2821>`_
5050
* `Adafruit Feather M0 Bluefruit LE <https://www.adafruit.com/products/2995>`_
5151

5252
.. _contents:
@@ -55,30 +55,35 @@ Full Table of Contents
5555
----------------------
5656

5757
.. toctree::
58-
:maxdepth: 3
59-
:caption: API and Usage
58+
:maxdepth: 3
59+
:caption: API and Usage
6060

61-
shared-bindings/index.rst
62-
docs/supported_ports.rst
63-
docs/troubleshooting.rst
64-
docs/drivers.rst
61+
shared-bindings/index.rst
62+
docs/supported_ports.rst
63+
docs/troubleshooting.rst
64+
docs/drivers.rst
6565

6666
.. toctree::
67-
:maxdepth: 3
68-
:caption: Developer reference
67+
:maxdepth: 3
68+
:caption: Developer reference
6969

70-
docs/design_guide
71-
docs/common_hal
72-
docs/library/index.rst
70+
docs/design_guide
71+
docs/common_hal
7372

7473
.. toctree::
75-
:maxdepth: 3
76-
:caption: About the project
74+
:maxdepth: 3
75+
:caption: MicroPython specific docs
7776

78-
README
79-
CONTRIBUTING
80-
CODE_OF_CONDUCT
81-
license.rst
77+
docs/library/index.rst
78+
79+
.. toctree::
80+
:maxdepth: 3
81+
:caption: About the project
82+
83+
README
84+
CONTRIBUTING
85+
CODE_OF_CONDUCT
86+
license.rst
8287

8388
Indices and tables
8489
==================

0 commit comments

Comments
 (0)
0