djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

59 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
Adafruit CircuitPython API Reference
====================================
Welcome to the API reference documentation for Adafruit CircuitPython.
This contains low-level API reference docs which may link out to separate
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
excellent tutorials available through the
`Adafruit Learning System <https://learn.adafruit.com/>`_.
.. include:: ../README.rst
.. _contents:
Full Table of Contents
----------------------
.. toctree::
:maxdepth: 3
:caption: API and Usage
../shared-bindings/index.rst
fix doc build; reorganize placement of library docs
2023-08-14 12:34:00 -04:00
library/index.rst
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
supported_ports.rst
troubleshooting.rst
remove micropython asyncio doc; update libraries page and links
2022-12-08 20:18:20 -05:00
libraries.rst
Clean up and add docs
2022-06-24 20:02:11 -04:00
workflows
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-06 19:54:02 -04:00
environment.rst
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
.. toctree::
:maxdepth: 1
:caption: Design and porting reference
design_guide
Merge remote-tracking branch 'adafruit/2.x' into merge_2x
2018-02-27 18:24:16 -05:00
porting
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
common_hal
Add back glossary to fix docs build
2023-10-16 15:15:42 -04:00
reference/glossary.rst
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
.. toctree::
:maxdepth: 2
fix doc build; reorganize placement of library docs
2023-08-14 12:34:00 -04:00
:caption: Python stand
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
.. toctree::
:maxdepth: 1
:caption: About the project
../README
../CONTRIBUTING
Add to BUILDING to table of contents.
2019-12-14 15:00:42 -05:00
../BUILDING
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
../CODE_OF_CONDUCT
update formatting of LICENSE and clean-up
2022-08-27 01:28:27 -04:00
../docs/LICENSE
Added WEBUSB_README to the table of contents (required by CI)
2021-02-04 09:56:51 -05:00
../WEBUSB_README
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215.
2018-02-20 20:34:59 -05:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`