circuitpython/docs
Damien George 9670a156da all: Rename MICROPY_PY_WIZNET5K to MICROPY_PY_NETWORK_WIZNET5K.
To match MICROPY_PY_NETWORK_CYW43 and MICROPY_PY_NETWORK_NINAW10.

Signed-off-by: Damien George <damien@micropython.org>
2022-06-07 16:55:18 +10:00
..
develop all: Remove third argument to MP_REGISTER_MODULE. 2022-06-02 16:31:37 +10:00
differences docs/differences: Update Python 3.5 diff, with optional listen backlog. 2022-04-11 15:28:56 +10:00
esp32 esp32/modesp32: Add new gpio_deep_sleep_hold function. 2022-03-21 23:59:07 +11:00
esp8266 docs: Remove reference to obsolete neopixel_write function. 2022-02-02 16:27:10 +11:00
library all: Rename MICROPY_PY_WIZNET5K to MICROPY_PY_NETWORK_WIZNET5K. 2022-06-07 16:55:18 +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 docs/reference/manifest: Add link to details about opt-level for freeze. 2022-05-27 14:45:46 +10:00
renesas-ra docs/renesas-ra: Remove unused image files. 2022-05-03 13:22:01 +10:00
rp2 docs/rp2/quickref.rst: Add section on PIO. 2021-11-19 15:30:14 +11: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.0.0. 2022-03-07 16:48:35 +11: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/README: Add short paragraph about using readthedocs. 2020-01-12 11:45:55 +11:00
conf.py all: Bump version to 1.18. 2022-01-17 09:50:31 +11: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 require rather complete install of LaTeX with various extensions. On Debian/Ubuntu, try (500MB+ download):

apt-get install texlive-latex-recommended texlive-latex-extra