github
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6042 Commits
3 Branches
62 Tags
504 MiB
 
 
 
 
 
 
Tree: 0d8c22b122
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0d8c22b122'
${ noResults }
micropython/docs
Paul Sokolovsky 0d8c22b122
docs/pyb.Pin: af_list() is a normal method, not a class method. 		9 years ago
..
esp8266 docs/esp8266/tutorial/network_basics: Minor typo fix, ap becomes ap_if. 9 years ago
library docs/pyb.Pin: af_list() is a normal method, not a class method. 9 years ago
pyboard docs: Update asm tutorial, maximum number of allowed args is now 4. 9 years ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 10 years ago
reference docs/speed_python: Add article. 9 years ago
static docs: Change "Micro Python" to "MicroPython" in all places in docs. 10 years ago
templates docs: Add link to PDF version of docs in sidebar. 9 years ago
wipy docs/wipy/tutorial: Add note about screen key bindings on OS X. 9 years ago
Makefile docs/Makefile: Default BUILDDIR based on MICROPY_PORT. 9 years ago
README.md docs/README: Add some hints for PDF docs generation. 9 years ago
conf.py docs: Add link to PDF version of docs in sidebar. 9 years ago
esp8266_contents.rst docs/esp8266_contents: Referebce general and tutorial docs. 9 years ago
esp8266_index.rst docs: Add esp8266 quick reference page, with basic info. 9 years ago
license.rst docs: Change "Micro Python" to "MicroPython" in all places in docs. 10 years ago
make.bat Add .gitattributes file to force text line endings to LF. 10 years ago
pyboard_contents.rst docs: Add "reference" directory for putting docs about the language. 10 years ago
pyboard_index.rst docs: Add initial draft documentation for the WiPy. 10 years ago
topindex.html docs/topindex.html: esp8266: Enable quickref/general on the main page. 9 years ago
unix_contents.rst docs: Actually add unix port indexes, so docs for it could be generated. 9 years ago
unix_index.rst docs: Actually add unix port indexes, so docs for it could be generated. 9 years ago
wipy_contents.rst docs/wipy: Add wipy tutorials section. 9 years ago
wipy_index.rst docs/wipy: Add wipy tutorials section. 9 years ago

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