0aa1d3f447
This clarifies return values and the handling of invalid (e.g. newline) characters. Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid characters in base64 input. Instead, it conforms to MIME handling of base64 (RFC 2045). Note that CPython doesn't document handling of invalid characters in a2b_base64() docs: https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so we specify it more explicitly than it, based on CPython's actual behavior (with which MicroPython now compliant). |
||
|---|---|---|
| .. | ||
| differences | ||
| esp8266 | ||
| library | ||
| pyboard | ||
| readthedocs/settings | ||
| reference | ||
| sphinx_selective_exclude | ||
| static | ||
| templates | ||
| wipy | ||
| Makefile | ||
| README.md | ||
| conf.py | ||
| esp8266_index.rst | ||
| license.rst | ||
| make.bat | ||
| pyboard_index.rst | ||
| unix_index.rst | ||
| wipy_index.rst | ||
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 MICROPY_PORT=<port_name> html
Where <port_name> can be unix, pyboard, wipy or esp8266.
You'll find the index page at micropython/docs/build/<port_name>/html/index.html.
PDF manual generation
This can be achieved with:
make MICROPY_PORT=<port_name> 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