circuitpython/docs
Lucian Copeland 3640ef2b7f Fix toctree, incorrect flash port assumptions 2020-09-14 17:37:55 -04:00
..
autoapi/templates/python Modify some Python stubs 2020-08-07 01:01:28 +09:00
library Fix minor typo in MicroPython libraries page 2020-07-06 09:56:52 -05:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
static Add license to some obvious files. 2020-07-06 19:16:25 +01:00
templates Comment that it may vary by board 2018-07-30 15:20:12 -07:00
README.md Refer to "main" branch of circuitpython 2020-06-25 11:42:23 -05:00
common_hal.md docs: Minor updates before 1.0.0 2017-07-19 15:13:23 -04:00
design_guide.rst docs: Explain our shift in terminology 2020-06-25 11:44:21 -05:00
drivers.rst make less vaguer 2019-02-15 18:12:58 -06:00
index.rst Add to BUILDING to table of contents. 2019-12-14 15:00:42 -05:00
porting.rst Fix trailing whitespace errors across ports and docs 2020-08-26 14:48:46 -04:00
redirects.txt redirects: Add __init__ page redirects 2020-06-26 15:06:22 -05:00
requirements.txt Apply a Sphinx transform to make the core module docs look better 2020-08-07 00:01:31 +09:00
rstjinja.py docs/rstjinja.py: add jinja processing for building latex (pdf) docs 2020-08-15 14:29:09 -05:00
shared_bindings_matrix.py shared_bindings_matrix revert to using shared-bindings 2020-08-29 07:37:00 -05:00
supported_ports.rst Fix toctree, incorrect flash port assumptions 2020-09-14 17:37:55 -04: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/main

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.