micropython/docs
Jim Mussared 59e3348c10 tools/mpremote: Add "edit" command.
This allows a remote file to be edited locally by copying it over, running
the local editor, then copying it back.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-08-18 22:29:13 +10:00
..
develop docs: Update links for Arm GCC toolchain. 2022-08-11 14:27:06 +10:00
differences docs/differences: Update Python 3.5 diff, with optional listen backlog. 2022-04-11 15:28:56 +10:00
esp32 docs/esp32: Fix string quoting consistency in SDCard mount example. 2022-08-17 12:00:35 +10:00
esp8266 docs: Update to use new WLAN argument names for ssid/security/key. 2022-06-17 21:43:44 +10:00
library extmod/uasyncio: Add clear method to ThreadSafeFlag. 2022-08-12 17:06:28 +10:00
mimxrt docs/mimxrt: Move the pinout tables to a separate document. 2022-05-27 12:48:16 +10:00
pyboard docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11: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 "edit" command. 2022-08-18 22:29:13 +10:00
renesas-ra docs/renesas-ra: Remove unused image files. 2022-05-03 13:22:01 +10:00
rp2 docs: Update Raspberry Pi URLs from .org to .com. 2022-06-14 11:41:13 +10:00
static docs: Add M-logo as favicon. 2017-02-07 20:04:40 +11:00
templates docs: Update files for renesas-ra port. 2022-04-29 12:29:08 +09: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: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
README.md docs: Set LaTeX engine to XeLaTeX for PDF generation. 2022-06-21 14:49:13 +10:00
conf.py docs: Set LaTeX engine to XeLaTeX for PDF generation. 2022-06-21 14:49:13 +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