Historia

Peter Hinch 521759ee18 docs: Add discussion on interrupt handlers incl uPy specific techniques.		2015-12-31 00:02:09 +00:00
..
library	docs/library: Add network server example.	2015-12-16 22:35:14 +01:00
pyboard	docs: Add link from pyboard asm tutorial to asm reference.	2015-06-26 12:35:17 +01:00
readthedocs/settings	docs: Add RTD local_settings file, to add custom templates.	2014-12-21 11:21:06 +00:00
reference	docs: Add discussion on interrupt handlers incl uPy specific techniques.	2015-12-31 00:02:09 +00:00
static	docs: Change "Micro Python" to "MicroPython" in all places in docs.	2015-06-04 23:53:26 +01:00
templates	docs: Make index link point to "index.html" irrespective of port.	2015-06-27 13:41:24 +01:00
wipy	docs/wipy: Make wifi/wlan naming consistent with tutorial.rst.	2015-11-18 20:02:07 +01:00
Makefile	docs: Initial commit of Sphinx documentation framework.	2014-09-25 17:23:06 +01:00
README.md	docs: Move instructions on generating the documentation to docs/README.md	2015-11-03 23:28:27 +00:00
conf.py	docs: Bump version to 1.5.1.	2015-11-23 21:27:33 +00:00
esp8266_contents.rst	docs: Add "reference" directory for putting docs about the language.	2015-06-25 00:20:57 +01:00
esp8266_index.rst	docs: Add initial draft documentation for the WiPy.	2015-06-10 23:37:56 +02:00
license.rst	docs: Change "Micro Python" to "MicroPython" in all places in docs.	2015-06-04 23:53:26 +01:00
make.bat	Add .gitattributes file to force text line endings to LF.	2015-04-16 22:23:56 +01:00
pyboard_contents.rst	docs: Add "reference" directory for putting docs about the language.	2015-06-25 00:20:57 +01:00
pyboard_index.rst	docs: Add initial draft documentation for the WiPy.	2015-06-10 23:37:56 +02:00
topindex.html	docs/wipy: Add wipy tutorials section.	2015-10-19 21:17:15 +02:00
unix_contents.rst	docs: Actually add unix port indexes, so docs for it could be generated.	2015-10-31 01:00:03 +03:00
unix_index.rst	docs: Actually add unix port indexes, so docs for it could be generated.	2015-10-31 01:00:03 +03:00
wipy_contents.rst	docs/wipy: Add wipy tutorials section.	2015-10-19 21:17:15 +02:00
wipy_index.rst	docs/wipy: Add wipy tutorials section.	2015-10-19 21:17:15 +02:00

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> BUILDDIR=build/<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.