The MicroPython project
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.
 
 
 
 
 
 
Jim Mussared 12ca918eb2 tools/mpremote: Add `mpremote mip install` to install packages. 7 days ago
..
develop top: Replace upip with mip everywhere. 5 days ago
differences docs: Update CPython differences and improve the look of table layouts. 1 month ago
esp32 docs/esp32: Update UART quickref on input-only pins. 1 month ago
esp8266 top: Replace upip with mip everywhere. 5 days ago
library extmod/modbluetooth: Replace def_handle with end_handle in char IRQ. 4 weeks ago
mimxrt mimxrt/machine_spi: Allow a setting of -1 for cs in the constructor. 3 weeks ago
pyboard top: Replace upip with mip everywhere. 5 days ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 8 years ago
reference tools/mpremote: Add `mpremote mip install` to install packages. 4 days ago
renesas-ra docs/renesas-ra: Add pin drive keyword argument description. 1 month ago
rp2 rp2/machine_wdt: Check for the maximum timeout value of watchdog. 1 month ago
static docs: Update CPython differences and improve the look of table layouts. 1 month ago
templates docs/templates/topindex.html: Update forum link. 1 month ago
unix unix: Implement `-X realtime` command-line option on macOS. 4 months ago
wipy docs: Use the correct * keyword-only notation. 8 months ago
zephyr zephyr: Upgrade to Zephyr v3.1.0. 4 months ago
Makefile docs/Makefile: Enable parallel compilation for Sphinx. 6 days ago
README.md docs: Set LaTeX engine to XeLaTeX for PDF generation. 4 months ago
conf.py docs: Update CPython differences and improve the look of table layouts. 1 month ago
index.rst docs: Update files for renesas-ra port. 5 months ago
license.rst docs/license: Update copyright year. 5 years ago
make.bat docs/make.bat: Change Windows output dir from '_build' to 'build'. 1 year ago

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.

Having readthedocs.org build the documentation

If you would like to have docs for forks/branches hosted on GitHub, GitLab or BitBucket an alternative to building the docs locally is to sign up for a free https://readthedocs.org account. The rough steps to follow are:

  1. sign-up for an account, unless you already have one
  2. in your account settings: add GitHub as a connected service (assuming you have forked this repo on github)
  3. in your account projects: import your forked/cloned micropython repository into readthedocs
  4. in the project's versions: add the branches you are developing on or for which you'd like readthedocs to auto-generate docs whenever you push a change

PDF manual generation

This can be achieved with:

make latexpdf

but requires a rather complete install of LaTeX with various extensions. On Debian/Ubuntu, try (1GB+ download):

apt install texlive-latex-recommended texlive-latex-extra texlive-xetex texlive-fonts-extra cm-super xindy