circuitpython/docs
Paul Sokolovsky ba33c544bb docs/conf.py: Set default_role = 'any'.
This causes `symbol` syntax to be equivalent to :any:`symbol`, which is
in turn the easiest way to cross-reference an arbitrary symbol in the
docs:

http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any

:any: requires at least Sphinx 1.3 (for reference, Ubuntu 16.03 ships
with 1.3.6, the latest 1.6.3).

Any many of our docs, `symbol` is misused to specify arguments to
functions, etc. Refactoring that is in progress. (CODECONVENTIONS
already specify proper syntax for both arguments and xrefs, based
on CPython conventions).
2017-06-25 00:57:44 +03:00
..
differences tools: Add gen-cpydiff.py to generate docs differences. 2017-02-20 17:14:34 +11:00
esp8266 docs/esp8266/tutorial/intro: Sphinx requires blank lines around literal blocks. 2017-06-23 22:04:33 +03:00
library docs/utime: Use markup adhering to the latest conventions. 2017-06-25 00:54:38 +03:00
pyboard stmhal: Add .value() method to Switch object, to mirror Pin and Signal. 2017-06-15 17:34:51 +10:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference docs/*/quickref.rst: Use new semantics of ticks_diff() 2016-11-08 02:01:05 +03:00
sphinx_selective_exclude various: Spelling fixes 2017-05-29 11:36:05 +03:00
static docs: Add M-logo as favicon. 2017-02-07 20:04:40 +11:00
templates docs: Add link to PDF version of docs in sidebar. 2016-06-06 11:37:40 +01:00
wipy docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc. 2017-06-03 14:19:53 +03:00
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 2017-02-27 15:39:55 +11:00
README.md docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
conf.py docs/conf.py: Set default_role = 'any'. 2017-06-25 00:57:44 +03:00
esp8266_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
esp8266_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
license.rst docs/license: Update copyright year. 2017-06-23 21:48:27 +03:00
make.bat Add .gitattributes file to force text line endings to LF. 2015-04-16 22:23:56 +01:00
pyboard_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
pyboard_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
topindex.html docs: Change single occurrence of "Micropython" to "MicroPython". 2017-05-17 12:38:33 +10:00
unix_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
unix_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
wipy_contents.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00
wipy_index.rst docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-20 17:14:35 +11:00

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