PythonExtra/docs
Jim Mussared 3cc6decfc4 py/py.mk: Make user-C-module handling self-contained in py.mk.
Removes the need for the port to add anything to OBJS or SRC_QSTR.

Also makes it possible for user-C-modules to differentiate between code
that should be processed for QSTR vs other files (e.g. helpers and
libraries).

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-10-11 23:23:18 +11:00
..
develop py/py.mk: Make user-C-module handling self-contained in py.mk. 2022-10-11 23:23:18 +11:00
differences docs: Update CPython differences and improve the look of table layouts. 2022-08-26 15:09:06 +10:00
esp32 docs/esp32: Update UART quickref on input-only pins. 2022-08-26 15:10:47 +10:00
esp8266 top: Replace upip with mip everywhere. 2022-09-30 17:34:03 +10:00
library extmod/modbluetooth: Replace def_handle with end_handle in char IRQ. 2022-09-09 11:24:24 +10:00
mimxrt mimxrt/machine_spi: Allow a setting of -1 for cs in the constructor. 2022-09-13 18:35:48 +10:00
pyboard top: Replace upip with mip everywhere. 2022-09-30 17:34:03 +10:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference tools/mpremote: Add `mpremote mip install` to install packages. 2022-10-01 22:44:24 +10:00
renesas-ra docs/renesas-ra: Add pin drive keyword argument description. 2022-08-31 12:01:38 +10:00
rp2 rp2/machine_wdt: Check for the maximum timeout value of watchdog. 2022-08-23 16:26:29 +10:00
static docs: Update CPython differences and improve the look of table layouts. 2022-08-26 15:09:06 +10:00
templates docs/templates/topindex.html: Update forum link. 2022-08-30 13:17:26 +10:00
unix unix: Implement `-X realtime` command-line option on macOS. 2022-05-24 00:51:47 +10:00
wipy docs: Use the correct * keyword-only notation. 2022-02-09 15:01:00 +11:00
zephyr zephyr: Upgrade to Zephyr v3.1.0. 2022-06-17 16:51:34 +10:00
Makefile docs/Makefile: Enable parallel compilation for Sphinx. 2022-09-29 23:51:29 +10:00
README.md docs: Set LaTeX engine to XeLaTeX for PDF generation. 2022-06-21 14:49:13 +10:00
conf.py docs: Update CPython differences and improve the look of table layouts. 2022-08-26 15:09:06 +10:00
index.rst docs: Update files for renesas-ra port. 2022-04-29 12:29:08 +09:00
license.rst docs/license: Update copyright year. 2017-06-23 21:48:27 +03:00
make.bat docs/make.bat: Change Windows output dir from '_build' to 'build'. 2021-09-13 18:15:38 +10: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.

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