Go to file
KB Sriram a9da9bc303 docs: update sphinx conf.py to use cp_typing.
- Adds circuitpython_typing to the intersphinx configuration.
- Adds a workaround to resolve TypeAliased references.

Fixes https://github.com/adafruit/circuitpython/issues/8119
2023-07-29 18:22:22 -07:00
.codespell remove lib from exludes, fix all remaining typos 2023-03-23 13:59:08 +07:00
.devcontainer fixed typo (path) in postCreateCommand 2022-12-16 09:13:34 +01:00
.github apt-get update before apt-get install for mpy-cross 2023-05-20 23:42:30 -04:00
LICENSES Add an explicit SPDX license file for ter-u12n. 2020-07-06 19:15:41 +01:00
data Silabs' new Pull Request for submoduling the ports/silabs/tools/slc_cli_linux/ (#7874) 2023-04-18 12:42:16 -04:00
devices/ble_hci fix typos (partial) detected by codepell 2023-03-18 22:17:02 +07:00
docs Update docs/workflows.md 2023-07-13 12:41:07 -05:00
examples fix typos (partial) detected by codepell 2023-03-18 22:17:02 +07:00
extmod bump ulab to fix rp2040 build error 2023-06-27 11:50:12 -05:00
frozen update frozen libraries 2023-07-25 08:58:37 -05:00
lib Align fatfs window buffer for tinyusb 2023-07-27 09:15:58 -07:00
locale Fix typo, oopsie 2023-07-29 15:10:09 +02:00
logo Add license to some obvious files. 2020-07-06 19:16:25 +01:00
mpy-cross Fix mpy-cross compile error with GCC13. 2023-04-11 19:38:27 +02:00
ports Merge pull request #8222 from tannewt/fat_window_align 2023-07-27 20:35:23 -04:00
py Merge pull request #8222 from tannewt/fat_window_align 2023-07-27 20:35:23 -04:00
shared fix typos (partial) detected by codepell 2023-03-18 22:17:02 +07:00
shared-bindings Merge pull request #8191 from gaweng/main 2023-07-24 10:18:56 -07:00
shared-module Fix typo, oopsie 2023-07-29 15:10:09 +02:00
supervisor Make usb_host.Port a singleton 2023-07-18 10:40:54 -07:00
tests Merge pull request #8126 from jepler/update-ulab-6.3.2 2023-07-26 11:54:42 -04:00
tools Improve error message 2023-07-29 14:39:44 +02:00
.codespellrc fix typos (partial) detected by codepell 2023-03-18 22:17:02 +07:00
.git-blame-ignore-revs top: Update .git-blame-ignore-revs for latest formatting commit. 2021-04-27 23:46:46 +10:00
.gitattributes Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
.gitignore Rename test function, make 'bad' files binary & add another test 2022-12-09 15:23:56 -06:00
.gitmodules Basic USB host support and keyboard workflow 2023-07-10 14:22:21 -07:00
.mailmap Add a `.mailmap` file to collate together multiple author entries. 2020-07-06 19:15:41 +01:00
.pre-commit-config.yaml remove certain excludes from pre-commit 2023-03-25 13:09:35 +05:30
.readthedocs.yml update `.readthedocs.yml` and add it to docs pattern 2023-03-11 11:56:04 +05:30
.rosie.yml Add license to some obvious files. 2020-07-06 19:16:25 +01:00
ACKNOWLEDGEMENTS Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
ACKNOWLEDGEMENTS.license Add license to some obvious files. 2020-07-06 19:16:25 +01:00
BUILDING.md fetch-port-submodules; fetch-all-submodules 2023-06-05 17:23:34 -04:00
CODE_OF_CONDUCT.md Fix up Contributor Covenant homepage link 2023-04-10 15:33:38 +12:00
CONTRIBUTING.md Fix error 2020-10-26 23:36:54 +01:00
LICENSE update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
LICENSE_MicroPython update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
Makefile fetch-port-submodules; fetch-all-submodules 2023-06-05 17:23:34 -04:00
README.rst Fix up EFR32 port readme 2023-05-28 16:01:59 +12:00
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
WEBUSB_README.md Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
conf.py docs: update sphinx conf.py to use cp_typing. 2023-07-29 18:22:22 -07:00
main.c Add Pimoroni Inky Frame 5.7 2023-05-11 12:12:34 -07:00
requirements-ci.txt only install `awscli` when required 2023-01-16 17:03:39 +05:30
requirements-dev.txt Silabs' new Pull Request for submoduling the ports/silabs/tools/slc_cli_linux/ (#7874) 2023-04-18 12:42:16 -04:00
requirements-doc.txt Updated how stubs are built 2023-05-09 22:01:24 -04:00
runtime.py Conditionalize LTO 2022-05-27 12:59:54 -07:00
setup.py-stubs use --long for describe in setup.py-stubs 2022-02-18 21:22:02 -05:00

README.rst-stubs

CircuitPython
=============

.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png

|Build Status| |Doc Status| |License| |Discord| |Weblate|

`circuitpython.org <https://circuitpython.org>`__ \| `Get CircuitPython <#get-circuitpython>`__ \|
`Documentation <#documentation>`__ \| `Contributing <#contributing>`__ \|
`Branding <#branding>`__ \| `Differences from Micropython <#differences-from-micropython>`__ \|
`Project Structure <#project-structure>`__

**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive
computers called microcontrollers.

This package contains the "stubs", or type definitions for CircuitPython.  With some advanced
editors and other tools, this information can be identify TypeErrors, AttributeErrors, and other
problems before you deploy your code to a device and can even help autocomplete your code.

.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
   :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain
.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
   :target: http://circuitpython.readthedocs.io/
.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg
   :target: https://adafru.it/discord
.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg
   :target: https://choosealicense.com/licenses/mit/
.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg
   :target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget