Skip to content

Files

Latest commit

b804443 · Jul 21, 2023

History

History
This branch is 1990 commits behind micropython/micropython:master.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jun 8, 2023
Dec 13, 2022
Jul 13, 2023
Apr 27, 2023
Jul 21, 2023
Jun 1, 2023
Apr 27, 2023
Dec 21, 2014
Jun 19, 2023
Jun 8, 2023
May 4, 2023
Jun 5, 2023
Aug 26, 2022
Oct 26, 2022
May 23, 2022
Feb 9, 2022
Jun 8, 2023
Sep 29, 2022
Jun 21, 2022
May 2, 2023
Oct 26, 2022
Jun 23, 2017
Sep 13, 2021

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