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.
8051 Commits
3 Branches
62 Tags
504 MiB
 
 
 
 
 
 
Tree: f8ac28964d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f8ac28964d'
${ noResults }
micropython/docs
Paul Sokolovsky f8ac28964d
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions. 		7 years ago
..
differences tools: Add gen-cpydiff.py to generate docs differences. 8 years ago
esp8266 docs/esp8266/tutorial/intro: Fix some grammatical typos. 7 years ago
library docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions. 7 years ago
pyboard stmhal: Add .value() method to Switch object, to mirror Pin and Signal. 8 years ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 10 years ago
reference docs/ref/speed_python: Update and make more hardware-neutral. 7 years ago
sphinx_selective_exclude various: Spelling fixes 8 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/uos: Move cc3200 port legacy VFS mounting functions to its ref doc. 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/conf.py: Set default_role = 'any'. 7 years ago
esp8266_index.rst docs: Move all ports docs to the single ToC. 7 years ago
license.rst docs/license: Update copyright year. 7 years ago
make.bat Add .gitattributes file to force text line endings to LF. 10 years ago
pyboard_index.rst docs: Move all ports docs to the single ToC. 7 years ago
topindex.html docs: Move all ports docs to the single ToC. 7 years ago
unix_index.rst docs: Move all ports docs to the single ToC. 7 years ago
wipy_index.rst docs: Move all ports docs to the single ToC. 7 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