d8e0320485
The WiPy machine.Timer class is very different to the esp8266 and esp32 implementations which are better candidates for a general Timer class. By moving the WiPy Timer docs to a completely separate file, under a new name machine.TimerWiPy, it gives a clean slate to define and write the docs for a better, general machine.Timer class. This is with the aim of eventually providing documentation that does not have conditional parts to it, conditional on the port. While the new docs are being defined it makes sense to keep the WiPy docs, since they describe its behaviour. Once the new Timer behaviour is defined the WiPy code can be changed to match it, and then the TimerWiPy docs would be removed. |
||
|---|---|---|
| .. | ||
| 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