circuitpython/docs
Damien George 805fd0cfe6 docs/library: Remove "only" directive from all pyb module docs.
By virtue of its name, the pyb module would only be available on a pyboard
and so does not need to have conditional "only" directives throughout its
documentation.

These conditionals were added mostly in
cfcf47c064 in the initial development of the
cc3200 port, which had the pyb module before it switched to the machine
module.  And wipy only conditionals were removed from the pyb module
documentation in 4542643025, so there's no
need to retain any more conditionals.
2018-07-18 15:47:44 +10:00
..
differences reference/index: Rewrite introduction paragraph to avoid confusion. 2017-07-01 22:09:40 +03:00
esp8266 docs/esp8266: Fix minor typo in "certificates". 2018-06-25 17:36:28 +10:00
library docs/library: Remove "only" directive from all pyb module docs. 2018-07-18 15:47:44 +10:00
pyboard docs/pyboard: For latex build, use smaller quickref jpg, and no gifs. 2018-07-10 12:45:52 +10:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11: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/pyboard: Move info about using Windows from topindex to general. 2017-07-03 15:31:41 +10:00
wipy docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc. 2017-06-03 14:19:53 +03:00
conf.py docs: Bump version to 1.9.4. 2018-05-11 16:39:59 +10:00
esp8266_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 2017-07-02 19:18:51 +03: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
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 2017-02-27 15:39:55 +11:00
pyboard_index.rst docs/pyboard: Move hardware info into General Info chapter. 2017-07-02 19:23:23 +03:00
README.md docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
unix_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 2017-07-02 19:18:51 +03:00
wipy_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 2017-07-02 19:18:51 +03:00

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