circuitpython/docs
Paul Sokolovsky 169b152f29 docs/ure: Fully describe supported syntax subset, add example. 2018-12-13 01:16:30 +11:00
..
differences reference/index: Rewrite introduction paragraph to avoid confusion. 2017-07-01 22:09:40 +03:00
esp8266 docs: Unify all the ports into one set of documentation. 2018-10-01 13:53:53 +10:00
library docs/ure: Fully describe supported syntax subset, add example. 2018-12-13 01:16:30 +11:00
pyboard docs: Unify all the ports into one set of documentation. 2018-10-01 13:53:53 +10:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference docs/reference/index: Remove conditional for inline asm docs. 2018-07-20 15:51:06 +10:00
static docs: Add M-logo as favicon. 2017-02-07 20:04:40 +11:00
templates docs: Unify all the ports into one set of documentation. 2018-10-01 13:53:53 +10:00
wipy docs/wipy: Fix links to network.Server, and markup for boot.py. 2018-10-01 14:08:02 +10:00
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 2017-02-27 15:39:55 +11:00
README.md docs/README: Remove references to MICROPY_PORT when building docs. 2018-12-11 02:55:22 +11:00
conf.py docs/conf.py: Use https for intersphinx link to docs.python.org. 2018-10-23 11:47:35 +11:00
index.rst docs: Unify all the ports into one set of documentation. 2018-10-01 13:53:53 +10:00
license.rst docs/license: Update copyright year. 2017-06-23 21:48:27 +03:00
make.bat Add .gitattributes file to force text line endings to LF. 2015-04-16 22:23:56 +01: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 html

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

PDF manual generation

This can be achieved with:

make 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