circuitpython/docs
Jim Mussared 4ddd46e6cf docs/develop/qstr.rst: Add documentation for string interning. 2019-10-04 17:13:13 +10:00
..
develop docs/develop/qstr.rst: Add documentation for string interning. 2019-10-04 17:13:13 +10:00
differences docs/differences: Clarify the differences are against Python 3.4. 2019-01-11 12:11:02 +11:00
esp32 esp32: Add support for hardware I2C. 2019-07-19 16:31:25 +10:00
esp8266 docs/esp8266: Add tutorial for APA102 LEDs. 2019-05-07 11:45:10 +10:00
library docs/library/pyb.USB_VCP.rst: Add info about id and flow params. 2019-09-26 14:00:21 +10:00
pyboard docs/pyboard: Emphasize the instructions for making a USB mouse. 2019-08-15 18:21:10 +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/speed_python: Add missing self to var caching example. 2019-08-28 12:55:41 +10: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 docs: Rename machine.ADC docs to machine.ADCWiPy. 2019-09-04 15:05:03 +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 all: Bump version to 1.11. 2019-05-29 16:38:10 +10:00
index.rst py: Update and rework build system for including external C modules. 2019-03-08 22:58:42 +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