circuitpython/docs/drivers.rst

Additional CircuitPython 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
`MicroPython <https://micropython.org>`_.


Adafruit CircuitPython Library Bundle
--------------------------------------

We provide a bundle of all our libraries to ease installation of drivers and
their dependencies. The bundle is primarily geared to the Adafruit Express line
of boards which feature a relatively large external flash. With Express boards,
it's easy to copy them all onto the filesystem. However, if you don't have
enough space simply copy things over as they are needed.

- The Adafruit bundles are available on GitHub: <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>.

- Documentation for the bundle, which includes links to documentation for all
  libraries, is available here: <https://circuitpython.readthedocs.io/projects/bundle/en/latest/>.


CircuitPython Community Library Bundle
---------------------------------------

This bundle contains non-Adafruit sponsored libraries, that are written and submitted
by members of the community.

- The Community bundles are available on GitHub: <https://github.com/adafruit/CircuitPython_Community_Bundle/releases>.

- Documentation is not available on ReadTheDocs at this time. See each library for any
  included documentation.
link to new drivers.rst on the Bundle 2019-02-14 21:45:46 -05:00			`Additional CircuitPython Libraries and Drivers on GitHub`
			`=========================================================`
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
Doc tweaks to clarify external libraries, new boards and add HID library. 2017-05-24 14:44:23 -04:00			`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>`_.
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 more description of installing the library bundle. 2017-01-13 20:00:26 -05:00
make less vaguer 2019-02-15 19:12:58 -05:00			`Adafruit CircuitPython Library Bundle`
			`--------------------------------------`
Add more detail to the driver page including a link to the bundle. 2017-01-06 16:18:40 -05:00
			`We provide a bundle of all our libraries to ease installation of drivers and`
Update driver links including categories! 2018-03-06 19:54:13 -05:00			`their dependencies. The bundle is primarily geared to the Adafruit Express line`
			`of boards which feature a relatively large external flash. With Express boards,`
Fix some spelling mistakes 2020-12-09 10:52:18 -05:00			`it's easy to copy them all onto the filesystem. However, if you don't have`
Update driver links including categories! 2018-03-06 19:54:13 -05:00			`enough space simply copy things over as they are needed.`
Add more detail to the driver page including a link to the bundle. 2017-01-06 16:18:40 -05:00
dropped the fancy URLs so Sphinx doesn't complain 2019-02-15 00:32:41 -05:00			`- The Adafruit bundles are available on GitHub: <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>.`
Add more detail to the driver page including a link to the bundle. 2017-01-06 16:18:40 -05:00
make less vaguer 2019-02-15 19:12:58 -05:00			`- Documentation for the bundle, which includes links to documentation for all`
			`libraries, is available here: <https://circuitpython.readthedocs.io/projects/bundle/en/latest/>.`
Update driver links including categories! 2018-03-06 19:54:13 -05:00

make less vaguer 2019-02-15 19:12:58 -05:00			`CircuitPython Community Library Bundle`
			`---------------------------------------`
Update driver links including categories! 2018-03-06 19:54:13 -05:00
link to new drivers.rst on the Bundle 2019-02-14 21:45:46 -05:00			`This bundle contains non-Adafruit sponsored libraries, that are written and submitted`
			`by members of the community.`
Add more detail to the driver page including a link to the bundle. 2017-01-06 16:18:40 -05:00
dropped the fancy URLs so Sphinx doesn't complain 2019-02-15 00:32:41 -05:00			`- The Community bundles are available on GitHub: <https://github.com/adafruit/CircuitPython_Community_Bundle/releases>.`
Add a micropython section and edit drivers doc 2017-09-02 09:37:14 -04:00
link to new drivers.rst on the Bundle 2019-02-14 21:45:46 -05:00			`- Documentation is not available on ReadTheDocs at this time. See each library for any`
			`included documentation.`