micropython/docs
misterdanb a0a08b4be1 esp8266: Add APA102 serial individually controllable LEDs support.
APA102 is a new "smart LED", similar to WS2812 aka "Neopixel".
2016-05-19 22:29:11 +03:00
..
esp8266 esp8266: Add APA102 serial individually controllable LEDs support. 2016-05-19 22:29:11 +03:00
library docs/ustruct: Describe supported type codes. 2016-05-14 20:48:43 +03:00
pyboard
readthedocs/settings
reference docs/speed_python: Add article. 2016-04-15 20:09:59 +03:00
static
templates docs: Make the short port names in the port/version sidebar lowercase. 2016-04-28 12:34:59 +01:00
wipy docs/machine: idle() description generalization. 2016-05-03 12:53:57 +03:00
Makefile docs/Makefile: Default BUILDDIR based on MICROPY_PORT. 2016-04-27 01:50:05 +03:00
README.md docs/Makefile: Default BUILDDIR based on MICROPY_PORT. 2016-04-27 01:50:05 +03:00
conf.py docs: Bump version to 1.8. 2016-05-03 17:32:32 +01:00
esp8266_contents.rst docs/esp8266_contents: Referebce general and tutorial docs. 2016-05-02 17:45:42 +03:00
esp8266_index.rst
license.rst
make.bat
pyboard_contents.rst
pyboard_index.rst
topindex.html docs/topindex.html: esp8266: Enable quickref/general on the main page. 2016-04-21 01:03:27 +03:00
unix_contents.rst
unix_index.rst
wipy_contents.rst
wipy_index.rst

README.md

MicroPython Documentation

The MicroPython documentation can be found at: http://docs.micropython.org/en/latest/

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

Building the documentation locally

If you're making changes to the documentation, you may want to 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/docs, build the docs:

make MICROPY_PORT=<port_name> html

Where <port_name> can be unix, pyboard, wipy or esp8266.

You'll find the index page at micropython/docs/build/<port_name>/html/index.html.