84958a8fe1
The size of the event ringbuf was previously fixed to compile-time config value, but it's necessary to sometimes increase this for applications that have large characteristic buffers to read, or many events at once. With this commit the size can be set via BLE.config(rxbuf=512), for example. This also resizes the internal event data buffer which sets the maximum size of incoming data passed to the event handler. |
||
|---|---|---|
| .. | ||
| develop | ||
| differences | ||
| esp32 | ||
| esp8266 | ||
| library | ||
| pyboard | ||
| readthedocs/settings | ||
| reference | ||
| static | ||
| templates | ||
| wipy | ||
| Makefile | ||
| README.md | ||
| conf.py | ||
| index.rst | ||
| license.rst | ||
| make.bat | ||
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.
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