circuitpython/docs
Scott Shawcroft 77db3d450e Add links to two more libraries. 2016-11-28 19:24:16 -08:00
..
esp8266 Merge tag 'v1.8.6' 2016-11-14 11:10:07 -08:00
library docs/library/machine.Pin: Update Pin docs to align with new HW API. 2016-11-09 11:08:01 +11:00
pyboard Merge tag 'v1.8.6' 2016-11-14 11:10:07 -08:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference docs/*/quickref.rst: Use new semantics of ticks_diff() 2016-11-08 02:01:05 +03:00
sphinx_selective_exclude docs: Add sphinx_selective_exclude extension suite. 2016-06-12 01:13:39 +03:00
static docs: Change "Micro Python" to "MicroPython" in all places in docs. 2015-06-04 23:53:26 +01:00
templates docs: Add link to PDF version of docs in sidebar. 2016-06-06 11:37:40 +01:00
wipy Documentation rework to unify the docs together rather than having them 2016-10-18 17:42:47 -07:00
README.md Documentation rework to unify the docs together rather than having them 2016-10-18 17:42:47 -07:00
c2rst.py Documentation rework to unify the docs together rather than having them 2016-10-18 17:42:47 -07:00
common_hal.md This introduces an alternative hardware API called nativeio structured around different functions that are typically accelerated by native hardware. Its not meant to reflect the structure of the hardware. 2016-11-21 14:11:52 -08:00
drivers.rst Add links to two more libraries. 2016-11-28 19:24:16 -08:00
supported_ports.rst This introduces an alternative hardware API called nativeio structured around different functions that are typically accelerated by native hardware. Its not meant to reflect the structure of the hardware. 2016-11-21 14:11:52 -08:00
unsupported_ports.rst This introduces an alternative hardware API called nativeio structured around different functions that are typically accelerated by native hardware. Its not meant to reflect the structure of the hardware. 2016-11-21 14:11:52 -08:00

README.md

Adafruit's MicroPython Documentation

The latest documentation can be found at: http://adafruit-micropython.readthedocs.io/en/latest/

The documentation you see there is generated from the files in the whole tree: https://github.com/adafruit/micropython/tree/master

Building the documentation locally

If you're making changes to the documentation, you should build the documentation locally so that you can preview your changes.

Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme, preferably in a virtualenv:

 pip install sphinx
 pip install sphinx_rtd_theme

In micropython/, build the docs:

sphinx-build -v -b html . _build/html

You'll find the index page at micropython/docs/_build/html/index.html.