circuitpython/docs
Jeff Epler f4bb3cc2c8 Fix stubs & doc redirects 2021-08-29 11:43:51 -05:00
..
autoapi/templates/python Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
library remove docs added in merge 2021-06-18 16:02:44 -05:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference Merge MicroPython 1.13 into CircuitPython 2021-05-04 18:06:33 -07:00
static add a filter text field to the support matrix 2021-04-15 19:05:50 +02:00
templates docs/rp2: Add skeleton docs for the rp2 port. 2021-05-30 22:31:34 +10:00
README.md Refer to "main" branch of circuitpython 2020-06-25 11:42:23 -05:00
common_hal.md It's "shared-module", not "shared-modules" 2021-08-03 10:37:47 -05:00
design_guide.rst adding parameter documentation explanation. 2021-05-15 12:06:08 -04:00
drivers.rst Fix some spelling mistakes 2020-12-10 02:52:18 +11:00
index.rst docs/rp2: Add skeleton docs for the rp2 port. 2021-05-30 22:31:34 +10:00
porting.rst remove gamepad; deprecate gamepadshift 2021-07-26 22:15:09 -04:00
redirects.txt Fix stubs & doc redirects 2021-08-29 11:43:51 -05:00
requirements.txt Switch from recommonmark to myst-parser 2021-05-05 15:25:37 -07: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 Remove OSError(0) and old network modules 2021-07-21 17:33:40 -07:00
supported_ports.rst Add initial RP2040 support 2021-01-20 19:16:56 -08:00
troubleshooting.rst Incompatible .mpy file 2021-05-23 08:51:35 +01: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.