ccbb5e84f9
Docs are here: http://tannewt-micropython.readthedocs.io/en/microcontroller/ It differs from upstream's machine in the following ways: * Python API is identical across ports due to code structure. (Lives in shared-bindings) * Focuses on abstracting common functionality (AnalogIn) and not representing structure (ADC). * Documentation lives with code making it easy to ensure they match. * Pin is split into references (board.D13 and microcontroller.pin.PA17) and functionality (DigitalInOut). * All nativeio classes claim underlying hardware resources when inited on construction, support Context Managers (aka with statements) and have deinit methods which release the claimed hardware. * All constructors take pin references rather than peripheral ids. Its up to the implementation to find hardware or throw and exception.
Adafruit's MicroPython Documentation
The latest documentation can be found at: http://adafruit-micropython.readthedocs.io/en/latest/
The documentation you see there is generated from the files in the whole tree: https://github.com/adafruit/micropython/tree/master
Building the documentation locally
If you're making changes to the documentation, you should 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/
, build the docs:
sphinx-build -v -b html . _build/html
You'll find the index page at micropython/docs/_build/html/index.html
.