Skip to content

Files

This branch is 2798 commits behind adafruit/circuitpython:main.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jul 27, 2021
Oct 24, 2023
Dec 21, 2014
Oct 24, 2023
Sep 19, 2023
Jan 14, 2022
Aug 27, 2022
Oct 16, 2021
Jan 27, 2024
Mar 20, 2023
Nov 11, 2023
Oct 16, 2023
Dec 9, 2022
Oct 24, 2023
Aug 9, 2022
Oct 2, 2023
Aug 22, 2023
Mar 20, 2024
Mar 19, 2024
Nov 2, 2021
Mar 19, 2024

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.