Dan Halbert 615ec7f74d merge from upstream 2019-10-14 18:12:58 -04:00
library add ':noindex:' to micropy's 'network.rst' to avoid sphinx conflict 2019-07-28 16:00:29 -05: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 Comment that it may vary by board 2018-07-30 15:20:12 -07:00 Cleaning up and fixing the docs generation Makefile and README instructions 2018-05-14 11:02:25 -07:00 change 'c2rst' from source_parser -> extension; allows use of sphinx 2.x 2019-07-28 15:59:26 -05:00 docs: Minor updates before 1.0.0 2017-07-19 15:13:23 -04:00
design_guide.rst Update import statement in code snippet. 2019-06-25 08:36:44 -04:00
drivers.rst make less vaguer 2019-02-15 18:12:58 -06: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
requirements.txt Pin dependencies to force sphinx 1.8.5 2019-05-11 21:24:39 -07:00 move the support matrix to its own page; add linking for modules 2019-07-27 10:03:18 -05:00 use 'any()' vs 'len == 1 & == False' 2019-10-02 00:02:49 -05:00
supported_ports.rst merge from upstream 2019-10-14 18:12:58 -04:00
troubleshooting.rst Delete a bunch of docs, drivers and examples not relevant to CircuitPython. 2018-02-20 17:34:59 -08:00

Adafruit's CircuitPython Documentation

The latest documentation can be found at:

The documentation you see there is generated from the files in the whole tree:

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.