circuitpython/docs
Damien George 1459a8d5c9 docs: Bump version to 1.8.2. 2016-07-10 12:46:50 +01:00
..
esp8266 docs/esp8266/tutorial/network_basics: Minor typo fix, ap becomes ap_if. 2016-06-06 10:08:30 +01:00
library docs/library: Fix typo in docs for usocket.listen(). 2016-06-26 12:38:20 +01:00
pyboard docs: Update asm tutorial, maximum number of allowed args is now 4. 2016-03-17 20:17:40 +00:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference docs/speed_python: Add article. 2016-04-15 20:09:59 +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 docs/wipy/tutorial: Add note about screen key bindings on OS X. 2016-06-02 00:13:21 +03:00
Makefile docs: Rebuild docs from scratch, as required for proper only:: handling. 2016-06-14 00:23:33 +03:00
README.md docs/README: Add some hints for PDF docs generation. 2016-06-02 00:08:47 +03:00
conf.py docs: Bump version to 1.8.2. 2016-07-10 12:46:50 +01:00
esp8266_contents.rst docs/esp8266_contents: Referebce general and tutorial docs. 2016-05-02 17:45:42 +03:00
esp8266_index.rst docs: Add esp8266 quick reference page, with basic info. 2016-03-08 23:06:15 +00: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/topindex.html: esp8266: Enable quickref/general on the main page. 2016-04-21 01:03:27 +03: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> 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 Debiab/Ubuntu, try (500MB+ download):

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