circuitpython/docs
Scott Shawcroft 6446010753
Wi-Fi autoconnect and title bar status
This adds support for CIRCUITPY_WIFI_SSID and CIRCUITPY_WIFI_PASSWORD
in `/.env`. When both are defined, CircuitPython will attempt to
connect to the network even when user code isn't running. If the
user code attempts to a network with the same SSID, it will return
immediately. Connecting to another SSID will disconnect from the
auto-connected network. If the user code initiates the connection,
then it will be shutdown after user code exits. (Should match <8
behavior.)

This PR also reworks the default displayio terminal. It now supports
a title bar TileGrid in addition to the (newly renamed) scroll area.
The default title bar is the top row of the display and is positioned
to the right of the Blinka logo when it is enabled. The scroll area
is now below the Blinka logo.

The Wi-Fi auto-connect code now uses the title bar to show its
state including the IP address when connected. It does this through
the "standard" OSC control sequence `ESC ] 0 ; <s> ESC \` where <s>
is the title bar string. This is commonly supported by terminals
so it should work over USB and UART as well.

Related to #6174
2022-06-09 14:55:54 -07:00
..
autoapi/templates/python Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
library Fix builtins.rst formatting via pre-commit 2022-05-13 12:03:14 -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
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 Update D13 to LED, add PWM example. 2021-10-28 13:30:51 -04:00
drivers.rst Fix some spelling mistakes 2020-12-10 02:52:18 +11:00
environment.rst Wi-Fi autoconnect and title bar status 2022-06-09 14:55:54 -07:00
index.rst Wi-Fi autoconnect and title bar status 2022-06-09 14:55:54 -07:00
porting.rst Remove gamepadshift module 2022-05-25 00:48:55 +02:00
redirects.txt Merge pull request #5491 from pypewpew/remove-gamepadshift 2022-05-25 13:58:06 -04: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 extract documentation URL from frozen directory README.rst 2022-05-11 15:33:20 +02: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

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.