circuitpython/docs
Dan Halbert 833f55922c
Remove multiterminal
This module has not been built in years, since the (removed) esp8266 port.
Delete the code, as it is not likely to be useful in its current form.

Closes: #7015
2022-10-06 14:02:47 -05:00
..
autoapi/templates/python Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
library add missing native modules to support matrix 2022-10-04 19:22:18 -04:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference Restore accidentally deleted 'glossary' 2022-02-16 15:34:11 -06:00
static extract documentation URL from frozen directory README.rst 2022-05-11 15:33:20 +02:00
templates Add newline at end of breadcrumbs.html 2022-01-14 13:29:13 -05: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 Remove multiterminal 2022-10-06 14:02:47 -05:00
drivers.rst Fix some spelling mistakes 2020-12-10 02:52:18 +11:00
environment.rst Add ability to reserve psram 2022-08-03 16:19:40 -05:00
index.rst update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
porting.rst Change I2C terminology from "peripheral" to "target" 2022-08-09 13:13:19 -04:00
redirects.txt Remove multiterminal 2022-10-06 14:02:47 -05: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 add missing native modules to support matrix 2022-10-04 19:22:18 -04: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 Fix trailing whitespace 2022-09-01 13:32:49 -07: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.