Latest commit a79f667 Dec 20, 2016 @mcauser mcauser committed with dpgeorge docs: Fix some minor spelling mistakes.
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
Permalink
..
Failed to load latest commit information.
esp8266 esp8266/general: Add "Scarcity of runtime resources" section. Jan 4, 2017
library docs: Fix some minor spelling mistakes. Jan 18, 2017
pyboard docs: Fix some minor spelling mistakes. Jan 18, 2017
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. Dec 21, 2014
reference docs/*/quickref.rst: Use new semantics of ticks_diff() Nov 7, 2016
sphinx_selective_exclude docs: Add sphinx_selective_exclude extension suite. Jun 11, 2016
static docs: Change "Micro Python" to "MicroPython" in all places in docs. Jun 4, 2015
templates docs: Add link to PDF version of docs in sidebar. Jun 6, 2016
wipy docs: Fix some minor spelling mistakes. Jan 18, 2017
Makefile docs: Rebuild docs from scratch, as required for proper only:: handling. Jun 13, 2016
README.md docs: Spelling mistakes Aug 2, 2016
conf.py docs: Bump version to 1.8.7. Jan 8, 2017
esp8266_contents.rst docs/esp8266_contents: Referebce general and tutorial docs. May 2, 2016
esp8266_index.rst docs: Add esp8266 quick reference page, with basic info. Mar 8, 2016
license.rst docs: Change "Micro Python" to "MicroPython" in all places in docs. Jun 4, 2015
make.bat Add .gitattributes file to force text line endings to LF. Apr 16, 2015
pyboard_contents.rst docs: Add "reference" directory for putting docs about the language. Jun 24, 2015
pyboard_index.rst docs: Add initial draft documentation for the WiPy. Jun 10, 2015
topindex.html docs/topindex.html: esp8266: Enable quickref/general on the main page. Apr 20, 2016
unix_contents.rst docs: Actually add unix port indexes, so docs for it could be generated. Oct 30, 2015
unix_index.rst docs: Actually add unix port indexes, so docs for it could be generated. Oct 30, 2015
wipy_contents.rst docs/wipy: Add wipy tutorials section. Oct 19, 2015
wipy_index.rst docs/wipy: Add wipy tutorials section. Oct 19, 2015

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.

PDF manual generation

This can be achieved with:

make MICROPY_PORT=<port_name> latexpdf

but require rather complete install of LaTeX with various extensions. On Debian/Ubuntu, try (500MB+ download):

apt-get install texlive-latex-recommended texlive-latex-extra