51805e4a3a
Docs are now by default rebuilt from scratch, as required to build conditionalized (i.e. using only:: directive) docs across different output types. We have pretty small docset, so that's still rather fast. However, if that's a concern, incremental rebuilds can be used by passing "FORCE=" (nothing after =) as a make parameter. This will work when using the same output type (e.g. only "html"). |
||
---|---|---|
.. | ||
esp8266 | ||
library | ||
pyboard | ||
readthedocs/settings | ||
reference | ||
sphinx_selective_exclude | ||
static | ||
templates | ||
wipy | ||
Makefile | ||
README.md | ||
conf.py | ||
esp8266_contents.rst | ||
esp8266_index.rst | ||
license.rst | ||
make.bat | ||
pyboard_contents.rst | ||
pyboard_index.rst | ||
topindex.html | ||
unix_contents.rst | ||
unix_index.rst | ||
wipy_contents.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 Debiab/Ubuntu, try (500MB+ download):
apt-get install texlive-latex-recommended texlive-latex-extra