circuitpython/docs
Scott Shawcroft 53bc6d4bd1
Fix docs build by splitting out support matrix
2023-10-24 16:20:51 -07:00
..
autoapi/templates/python Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
library add platform.rst to library docs 2023-10-24 14:20:56 -04:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference Remove mpremote ref 2023-10-24 14:14:43 -07:00
static initial merge from v1.20.0; just satisifying conflicts 2023-09-19 11:10:12 -04:00
templates docs/samd: Add documentation for the samd port. 2022-10-26 23:39:35 +11:00
LICENSE.md update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
README.md docs: Set LaTeX engine to XeLaTeX for PDF generation. 2022-06-21 14:49:13 +10: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 Add back glossary to fix docs build 2023-10-16 12:15:42 -07:00
libraries.rst remove micropython asyncio doc; update libraries page and links 2022-12-08 20:23:02 -05:00
pdf.rst Fix docs build by splitting out support matrix 2023-10-24 16:20:51 -07:00
porting.rst Change I2C terminology from "peripheral" to "target" 2022-08-09 13:13:19 -04:00
redirects.txt Remove one I2CPeripheral leftover 2023-10-02 14:36:19 -07:00
rstjinja.py Use the ".. jinja" tag to render support_matrix template 2023-08-21 21:34:14 -05:00
shared_bindings_matrix.py restore old uzlib; remove remaining U and u prefixes 2023-10-19 21:29:57 -04:00
supported_ports.rst Fix docs build by splitting out support matrix 2023-10-24 16:20:51 -07:00
troubleshooting.rst Update link. 2021-11-02 13:52:40 -04:00
workflows.md Wifi fully seperate from web-workflow 2023-09-05 22:39:41 +03: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.