|
|
%!s(int64=4) %!d(string=hai) anos | |
|---|---|---|
| .. | ||
| differences | %!s(int64=4) %!d(string=hai) anos | |
| esp8266 | %!s(int64=4) %!d(string=hai) anos | |
| library | %!s(int64=4) %!d(string=hai) anos | |
| pyboard | %!s(int64=4) %!d(string=hai) anos | |
| readthedocs | %!s(int64=4) %!d(string=hai) anos | |
| reference | %!s(int64=4) %!d(string=hai) anos | |
| sphinx_selective_exclude | %!s(int64=4) %!d(string=hai) anos | |
| static | %!s(int64=4) %!d(string=hai) anos | |
| templates | %!s(int64=4) %!d(string=hai) anos | |
| wipy | %!s(int64=4) %!d(string=hai) anos | |
| Makefile | %!s(int64=4) %!d(string=hai) anos | |
| README.md | %!s(int64=4) %!d(string=hai) anos | |
| conf.py | %!s(int64=4) %!d(string=hai) anos | |
| esp8266_index.rst | %!s(int64=4) %!d(string=hai) anos | |
| license.rst | %!s(int64=4) %!d(string=hai) anos | |
| make.bat | %!s(int64=4) %!d(string=hai) anos | |
| pyboard_index.rst | %!s(int64=4) %!d(string=hai) anos | |
| unix_index.rst | %!s(int64=4) %!d(string=hai) anos | |
| wipy_index.rst | %!s(int64=4) %!d(string=hai) anos | |
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
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.
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