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.
7896 Commits
3 Branches
62 Tags
504 MiB
 
 
 
 
 
 
Tree: e1b0f2a16f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e1b0f2a16f'
${ noResults }
micropython/docs
Damien George d007351b33
docs/library/micropython: Document the newer micropython functions. 		8 years ago
..
differences tools: Add gen-cpydiff.py to generate docs differences. 8 years ago
esp8266 docs/esp8266/quickref: Add links from quickref page to machine classes. 8 years ago
library docs/library/micropython: Document the newer micropython functions. 8 years ago
pyboard stmhal: Add ability to skip booting from SD card via /flash/SKIPSD file. 8 years ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 10 years ago
reference docs/*/quickref.rst: Use new semantics of ticks_diff() 8 years ago
sphinx_selective_exclude docs: Add sphinx_selective_exclude extension suite. 9 years ago
static docs: Add M-logo as favicon. 8 years ago
templates docs: Add link to PDF version of docs in sidebar. 9 years ago
wipy docs/wipy/general: Add section about specifics of I2C implementation. 8 years ago
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 8 years ago
README.md docs: Spelling mistakes 8 years ago
conf.py docs: Add M-logo as favicon. 8 years ago
esp8266_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 years ago
esp8266_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 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: Modify Makefile and indexes to generate cPy-differences pages. 8 years ago
pyboard_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 years ago
topindex.html docs: Change single occurrence of "Micropython" to "MicroPython". 8 years ago
unix_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 years ago
unix_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 years ago
wipy_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 years ago
wipy_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 8 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 Debian/Ubuntu, try (500MB+ download):

apt-get install texlive-latex-recommended texlive-latex-extra