You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Paul Sokolovsky 5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
5 years ago
differences reference/index: Rewrite introduction paragraph to avoid confusion. 6 years ago
esp8266 docs/esp8266/tutorial: Fix typo, change -> changed. 5 years ago
library docs/library/index: Elaborate uPy libraries intro. 5 years ago
pyboard docs/pyboard/tutorial: Update now that yellow LED also supports PWM. 5 years ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 8 years ago
reference docs/packages: Explicitly recommend usage of setuptools instead of distutils. 5 years ago
sphinx_selective_exclude various: Spelling fixes 6 years ago
static docs: Add M-logo as favicon. 6 years ago
templates docs/pyboard: Move info about using Windows from topindex to general. 6 years ago
wipy docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc. 6 years ago
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 6 years ago docs: Spelling mistakes 7 years ago docs/conf: Reference CPython 3.5 docs. 5 years ago
esp8266_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 6 years ago
license.rst docs/license: Update copyright year. 6 years ago
make.bat Add .gitattributes file to force text line endings to LF. 8 years ago
pyboard_index.rst docs/pyboard: Move hardware info into General Info chapter. 6 years ago
unix_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 6 years ago
wipy_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 6 years ago

MicroPython Documentation

The MicroPython documentation can be found at:

The documentation you see there is generated from the files in the docs tree:

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