Skip to content
Snippets Groups Projects
Select Git revision
  • ef9843653b795b650e1fe77e22f87e3523bd0a08
  • wip-bootstrap default
  • dualcore
  • ch3/leds
  • ch3/time
  • master
6 results

docs

  • Clone with SSH
  • Clone with HTTPS
  • user avatar
    Yonatan Goldschmidt authored and Damien George committed
    Selectable at compile time via MICROPY_PY_UCRYPTOLIB_CTR.  Disabled by
    default.
    ef984365
    History

    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