6446010753
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 |
||
|---|---|---|
| .. | ||
| autoapi/templates/python | ||
| library | ||
| readthedocs/settings | ||
| reference | ||
| static | ||
| templates | ||
| common_hal.md | ||
| design_guide.rst | ||
| drivers.rst | ||
| environment.rst | ||
| index.rst | ||
| porting.rst | ||
| README.md | ||
| redirects.txt | ||
| rstjinja.py | ||
| shared_bindings_matrix.py | ||
| supported_ports.rst | ||
| troubleshooting.rst | ||
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.