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.
sommersoft 8c75962850 add ':noindex:' to micropy's 'network.rst' to avoid sphinx conflict 3 years ago
library add ':noindex:' to micropy's 'network.rst' to avoid sphinx conflict 3 years ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 8 years ago
static Update favicon to blinka. 5 years ago
templates Comment that it may vary by board 4 years ago Cleaning up and fixing the docs generation Makefile and README instructions 5 years ago change 'c2rst' from source_parser -> extension; allows use of sphinx 2.x 3 years ago docs: Minor updates before 1.0.0 5 years ago
design_guide.rst Update import statement in code snippet. 4 years ago
drivers.rst make less vaguer 4 years ago
index.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 5 years ago
porting.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 5 years ago
requirements.txt Pin dependencies to force sphinx 1.8.5 4 years ago move the support matrix to its own page; add linking for modules 3 years ago fix board_exclusion lookup 3 years ago
supported_ports.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 5 years ago
troubleshooting.rst Delete a bunch of docs, drivers and examples not relevant to CircuitPython. 5 years ago

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.