circuitpython/docs
Scott Shawcroft 8e6feecf11
Merge pull request #863 from dhalbert/3.0_doc_updates
RTD documentation updates
2018-05-23 12:57:34 -07:00
..
library typos in builtins.rst 2018-05-23 15:07:32 -04:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
static Update favicon to blinka. 2017-07-28 16:33:07 -07:00
templates add caveat language re MicroPython libraries; other slight changes 2018-05-22 20:49:08 -04:00
README.md Cleaning up and fixing the docs generation Makefile and README instructions 2018-05-14 11:02:25 -07:00
c2rst.py Fix ReadTheDocs build due to c2rst. 2018-05-23 11:53:00 -07:00
common_hal.md docs: Minor updates before 1.0.0 2017-07-19 15:13:23 -04:00
design_guide.rst ustruct -> struct in design_guide.rst 2018-05-23 15:05:38 -04:00
drivers.rst Add four missing drivers 2018-03-27 14:25:14 -07:00
index.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
porting.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
supported_ports.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
troubleshooting.rst Delete a bunch of docs, drivers and examples not relevant to CircuitPython. 2018-02-20 17:34:59 -08:00

README.md

Adafruit's CircuitPython Documentation

The latest documentation can be found at: http://circuitpython.readthedocs.io/en/latest/

The documentation you see there is generated from the files in the whole tree: https://github.com/adafruit/circuitpython/tree/master

Building the documentation locally

If you're making changes to the documentation, you should build the documentation locally so that you can preview your changes.

Install Sphinx, recommonmark, and optionally (for the RTD-styling), sphinx_rtd_theme, preferably in a virtualenv:

 pip install sphinx
 pip install recommonmark
 pip install sphinx_rtd_theme

In circuitpython/, build the docs:

make html

You'll find the index page at _build/html/index.html.

More flexibility

Running make by itself will list out the multiple doc generating commands available.

All commands will, by default, run with -E (forces a rebuild from scratch of docs) and -v (verbosity level 1). This can be customized as desired:

# will turn OFF the force rebuild
make html FORCE=

# will turn OFF the verbosity
make html VERBOSE=

# will turn OFF the force rebuild and make it doubly verbose when running
make html FORCE= VERBOSE="-v -v"

You can also pass other options to sphinx by using SPHINXOPTS.

make html SPHINXOPTS="-T"

For more flexibility and customization, take a look at the Makefile for all variables you can pass in and overwrite.