circuitpython/docs
Yonatan Goldschmidt 9521399044 docs/uos: Document extra requirements on stream objs passed to dupterm.
This is only correct for the extmod/uos_dupterm.c implementation however,
as e.g cc3200 implementation does the mp_load_method() itself, and anyway
requires `read` instead of `readinto`.
2019-02-26 01:12:37 +11:00
..
differences docs/differences: Clarify the differences are against Python 3.4. 2019-01-11 12:11:02 +11:00
esp32 docs: Convert all cases of machine.sleep to machine.lightsleep. 2019-01-30 14:15:51 +11:00
esp8266 docs: Unify all the ports into one set of documentation. 2018-10-01 13:53:53 +10:00
library docs/uos: Document extra requirements on stream objs passed to dupterm. 2019-02-26 01:12:37 +11:00
pyboard all: Change PYB message prefix to MPY. 2019-02-12 15:18:33 +11:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference all: Change PYB message prefix to MPY. 2019-02-12 15:18:33 +11:00
static docs: Add M-logo as favicon. 2017-02-07 20:04:40 +11:00
templates docs: Add initial docs for esp32 port, including quick-ref and general. 2019-01-25 12:18:34 +11:00
wipy all: Change PYB message prefix to MPY. 2019-02-12 15:18:33 +11: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 all: Bump version to 1.10. 2019-01-26 00:56:48 +11:00
index.rst docs: Add initial docs for esp32 port, including quick-ref and general. 2019-01-25 12:18:34 +11: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