circuitpython/docs
silabs-BelaV 4e25a4f6b3
Silabs' new Pull Request for submoduling the ports/silabs/tools/slc_cli_linux/ (#7874)
Doing a squash merge to avoid having the `slc_cli_linux` .zip files in the history. They were added in one commit and removed and replaced with a submodule in another.

* Initial commit for xg24

* Fix SLC issue

* Fix SLC extract fail

* Change board's name

* Correct spelling of code

Build immediately after slc generate

* Remove VID and PID

* Change creator and creation id

* Apply new creator_id and creation_id

* Update makefile, error message, mcu_processor function

* Update mpconfigboard.mk

* Update Board extensions, PORT_DEPS

* Update makefile

* Add exclude_patterns

* Show java, jinja2 version

* Show path for debugging CI

* Add requirements-dev for slc

* Add PATH slc_cli

* Update background function

* Add jinja2 PATH

* Show PATH

* Update jinja2 path

* Update jinja2 path

* Update jinja2 path

* Update jinja2 path

* Change slc folder

* Change markupsafe folder

* Add symbolic link for slc

* Update makefile

* Update makefile

* Update MX25R3235F.toml from submodule nvm.toml

* alphabetize the list

* Remove slc_cli_linux folder

* Update slc_cli submodule

---------

Co-authored-by: Chat Nguyen <cvnguyen@silabs.com>
Co-authored-by: silabs-ChatNguyen <chat.nguyen@silabs.com>
Co-authored-by: silabs-ChatNguyen <126220343+silabs-ChatNguyen@users.noreply.github.com>
2023-04-18 12:42:16 -04:00
..
autoapi/templates/python Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
library remove micropython asyncio doc; update libraries page and links 2022-12-08 20:23:02 -05: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 removing need to use print format option. 2023-03-20 17:23:49 -04:00
environment.rst Fix documentation format error 2023-04-07 12:09:51 -07:00
index.rst remove micropython asyncio doc; update libraries page and links 2022-12-08 20:23:02 -05: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 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 Silabs' new Pull Request for submoduling the ports/silabs/tools/slc_cli_linux/ (#7874) 2023-04-18 12:42:16 -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 Add device name env variable for web workflow 2023-04-07 11:45:13 -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.