circuitpython/docs
Jeff Epler c029d6a165
Merge remote-tracking branch 'origin/8.2.x' into merge-82x
2023-08-22 08:49:16 -05:00
..
autoapi/templates/python Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
library fix doc build; reorganize placement of library docs 2023-08-14 12:34:00 -04:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference Make natmods work again. 2023-08-19 16:59:13 -05:00
static extract documentation URL from frozen directory README.rst 2022-05-11 15:33:20 +02:00
templates docs: Update files for renesas-ra port. 2022-04-29 12:29:08 +09:00
LICENSE.md update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
README.md Update README in docs/ 2021-10-16 17:46:28 -04:00
common_hal.md It's "shared-module", not "shared-modules" 2021-08-03 10:37:47 -05:00
design_guide.rst removing need to use print format option. 2023-03-20 17:23:49 -04:00
environment.rst document CIRCUITPY_PYSTACK_SIZE 2023-05-09 14:30:25 +02:00
index.rst fix doc build; reorganize placement of library docs 2023-08-14 12:34:00 -04:00
libraries.rst remove micropython asyncio doc; update libraries page and links 2022-12-08 20:23:02 -05:00
porting.rst Change I2C terminology from "peripheral" to "target" 2022-08-09 13:13:19 -04:00
redirects.txt Add index.html as a redirect to README.html 2023-08-02 09:34:33 -05:00
rstjinja.py Use the ".. jinja" tag to render support_matrix template 2023-08-21 21:34:14 -05:00
shared_bindings_matrix.py Merge remote-tracking branch 'origin/8.2.x' into merge-82x 2023-08-22 08:49:16 -05:00
supported_ports.rst Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
troubleshooting.rst Update link. 2021-11-02 13:52:40 -04:00
workflows.md initial v1.19.1 merge; not compiled yet 2023-08-01 13:50:05 -04: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 the necessary packages, preferably in a virtualenv, in circuitpython/:

pip install -r requirements-doc.txt

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.