circuitpython/docs
NitiKaur 01953f2964 docs/differences: Document details of new PEPs/features in Python 3.5+.
And how they relate to MicroPython.  As these features are implemented (or
the decision is made to not implement them) the tables can be updated to
document the differences between MicroPython and standard Python.
2022-01-05 22:49:20 +11:00
..
develop py/runtime: Allow initialising sys.path/argv with defaults. 2021-12-18 00:08:07 +11:00
differences docs/differences: Document details of new PEPs/features in Python 3.5+. 2022-01-05 22:49:20 +11:00
esp32 esp32/machine_pwm: Keep duty constant when changing frequency. 2021-12-22 00:05:58 +11:00
esp8266 docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
library docs/library/sys.rst: Add note about '.frozen' as an entry in sys.path. 2021-12-18 00:08:07 +11: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: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11: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/templates: Add unix and zephyr quickref links to top-index. 2021-08-13 20:21:21 +10:00
unix windows: Improve default search path. 2020-02-11 13:34:35 +11:00
wipy docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
zephyr docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +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/README: Add short paragraph about using readthedocs. 2020-01-12 11:45:55 +11:00
conf.py all: Bump version to 1.17. 2021-09-02 00:07:13 +10:00
index.rst docs/zephyr: Add quick reference for the Zephyr port. 2021-08-13 20:20:57 +10: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