micropython/docs
robert-hh 633408a4a5 docs/samd: Add the pin-out for the Adafruit Metro M4 Airlift board.
Signed-off-by: robert-hh <robert@hammelrath.com>
2023-06-01 12:38:58 +10:00
..
develop docs/develop/porting: Add missing code to example main.c and Makefile. 2023-05-19 21:51:19 +10:00
differences
esp32 docs: Update the PWM examples based on recent API improvements. 2023-05-04 13:15:55 +10:00
esp8266 all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
library esp32/esp32_ulp: Enable FSM ULP for S2 and S3 chips. 2023-05-19 22:37:25 +10:00
mimxrt docs/mimxrt: Add the pin-out for the Adafruit Metro M7 board. 2023-06-01 12:38:58 +10:00
pyboard all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
readthedocs/settings
reference docs/reference/speed_python: Remove 4-arg limit for viper. 2023-05-23 17:40:17 +10:00
renesas-ra renesas-ra: Change MICROPY_HW_BOARD_NAME definition to product name. 2023-04-27 14:12:53 +10:00
rp2 docs: Update the PWM examples based on recent API improvements. 2023-05-04 13:15:55 +10:00
samd docs/samd: Add the pin-out for the Adafruit Metro M4 Airlift board. 2023-06-01 12:38:58 +10:00
static
templates
unix
wipy
zephyr all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
Makefile
README.md
conf.py all: Fix strings with backslash by using raw string literals. 2023-05-02 11:55:02 +10:00
index.rst
license.rst
make.bat

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