Merge branch 'main' into master

Author: tannewt

.github/workflows/build.yml

@@ -16,16 +16,15 @@ jobs:
       env:
         GITHUB_CONTEXT: ${{ toJson(github) }}
       run: echo "$GITHUB_CONTEXT"
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.2.0
       with:
         submodules: true
         fetch-depth: 0
     - run: git fetch --recurse-submodules=no https://github.com/adafruit/circuitpython refs/tags/*:refs/tags/*
-    - run: git submodule sync
-    - run: git submodule foreach git remote -v
-    - run: git submodule foreach git fetch --recurse-submodules=no origin +refs/tags/*:refs/tags/*
     - name: CircuitPython version
-      run: git describe --dirty --tags
+      run: |
+        git describe --dirty --tags
+        echo "::set-env name=CP_VERSION::$(git describe --dirty --tags)"
     - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
@@ -66,8 +65,16 @@ jobs:
       working-directory: tests
     - name: Stubs
       run: make stubs -j2
+    - uses: actions/upload-artifact@v2
+      with:
+        name: stubs
+        path: circuitpython-stubs*
     - name: Docs
-      run: sphinx-build -E -W -b html . _build/html
+      run: sphinx-build -E -W -b html -D version=${{ env.CP_VERSION }} -D release=${{ env.CP_VERSION }} . _build/html
+    - uses: actions/upload-artifact@v2
+      with:
+        name: docs
+        path: _build/html
     - name: Translations
       run: make check-translate
     - name: New boards check
@@ -110,14 +117,11 @@ jobs:
         gcc --version
         python3 --version
         msgfmt --version
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.2.0
       with:
         submodules: true
         fetch-depth: 0
     - run: git fetch --recurse-submodules=no https://github.com/adafruit/circuitpython refs/tags/*:refs/tags/*
-    - run: git submodule sync
-    - run: git submodule foreach git remote -v
-    - run: git submodule foreach git fetch --recurse-submodules=no origin +refs/tags/*:refs/tags/*
     - name: CircuitPython version
       run: git describe --dirty --tags
     - name: Build mpy-cross
@@ -145,6 +149,7 @@ jobs:
         - "arduino_zero"
         - "bast_pro_mini_m0"
         - "bdmicro_vina_m0"
+        - "bless_dev_board_multi_sensor"
         - "capablerobot_usbhub"
         - "catwan_usbstick"
         - "circuitbrains_basic_m0"
@@ -193,6 +198,7 @@ jobs:
         - "itsybitsy_m4_express"
         - "itsybitsy_nrf52840_express"
         - "kicksat-sprite"
+        - "loc_ber_m4_base_board"
         - "makerdiary_m60_keyboard"
         - "makerdiary_nrf52840_m2_devkit"
         - "makerdiary_nrf52840_mdk"
@@ -235,8 +241,11 @@ jobs:
         - "pyportal"
         - "pyportal_titano"
         - "pyruler"
+        - "raytac_mdbt50q-db-40"
         - "robohatmm1_m4"
         - "sam32"
+        - "same54_xplained"
+        - "seeeduino_wio_terminal"
         - "seeeduino_xiao"
         - "serpente"
         - "shirtty"
@@ -288,14 +297,11 @@ jobs:
         gcc --version
         arm-none-eabi-gcc --version
         python3 --version
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.2.0
       with:
         submodules: true
         fetch-depth: 0
     - run: git fetch --recurse-submodules=no https://github.com/adafruit/circuitpython refs/tags/*:refs/tags/*
-    - run: git submodule sync
-    - run: git submodule foreach git remote -v
-    - run: git submodule foreach git fetch --recurse-submodules=no origin +refs/tags/*:refs/tags/*
     - name: mpy-cross
       run: make -C mpy-cross -j2
     - name: build
@@ -339,14 +345,11 @@ jobs:
         gcc --version
         riscv64-unknown-elf-gcc --version
         python3 --version
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.2.0
       with:
         submodules: true
         fetch-depth: 0
     - run: git fetch --recurse-submodules=no https://github.com/adafruit/circuitpython refs/tags/*:refs/tags/*
-    - run: git submodule sync
-    - run: git submodule foreach git remote -v
-    - run: git submodule foreach git fetch --recurse-submodules=no origin +refs/tags/*:refs/tags/*
     - name: mpy-cross
       run: make -C mpy-cross -j2
     - name: build
@@ -373,20 +376,18 @@ jobs:
         board:
         - "espressif_saola_1_wroom"
         - "espressif_saola_1_wrover"
+        - "unexpectedmaker_feathers2"
 
     steps:
     - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
         python-version: 3.8
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.2.0
       with:
         submodules: true
         fetch-depth: 0
     - run: git fetch --recurse-submodules=no https://github.com/adafruit/circuitpython refs/tags/*:refs/tags/*
-    - run: git submodule sync
-    - run: git submodule foreach git remote -v
-    - run: git submodule foreach git fetch --recurse-submodules=no origin +refs/tags/*:refs/tags/*
     - name: CircuitPython version
       run: git describe --dirty --tags
     - uses: actions/cache@v1

.github/workflows/create_website_pr.yml

@@ -23,12 +23,11 @@ jobs:
       run: |
         gcc --version
         python3 --version
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.2.0
       with:
         submodules: true
         fetch-depth: 0
     - run: git fetch --recurse-submodules=no https://github.com/adafruit/circuitpython refs/tags/*:refs/tags/*
-    - run: git submodule foreach git fetch --recurse-submodules=no origin +refs/tags/*:refs/tags/*
     - name: CircuitPython version
       run: git describe --dirty --tags
     - name: Website

.github/workflows/pre-commit.yml

@@ -7,7 +7,7 @@ name: pre-commit
 on:
   pull_request:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   pre-commit:

.gitignore

@@ -53,6 +53,7 @@ _build
 ######################
 genrst/
 /autoapi/
+/shared-bindings/**/*.rst
 
 # ctags and similar
 ###################

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 Please note that this project is released with a
-[Contributor Code of Conduct](https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md).
+[Contributor Code of Conduct](https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md).
 By participating in this project you agree to abide by its terms. Participation
 covers any forum used to converse about CircuitPython including unofficial and official spaces. Failure to do
 so will result in corrective actions such as time out or ban from the project.

Makefile

@@ -243,3 +243,49 @@ stubs:
 update-frozen-libraries:
 	@echo "Updating all frozen libraries to latest tagged version."
 	cd frozen; for library in *; do cd $$library; ../../tools/git-checkout-latest-tag.sh; cd ..; done
+
+one-of-each: samd21 samd51 esp32s2 litex mimxrt10xx nrf stm
+
+samd21:
+	$(MAKE) -C ports/atmel-samd BOARD=trinket_m0
+
+samd51:
+	$(MAKE) -C ports/atmel-samd BOARD=feather_m4_express
+
+esp32s2:
+	$(MAKE) -C ports/esp32s2 BOARD=espressif_saola_1_wroom
+
+litex:
+	$(MAKE) -C ports/litex BOARD=fomu
+
+mimxrt10xx:
+	$(MAKE) -C ports/mimxrt10xx BOARD=feather_mimxrt1011
+
+nrf:
+	$(MAKE) -C ports/nrf BOARD=feather_nrf52840_express
+
+stm:
+	$(MAKE) -C ports/stm BOARD=feather_stm32f405_express
+
+clean-one-of-each: clean-samd21 clean-samd51 clean-esp32s2 clean-litex clean-mimxrt10xx clean-nrf clean-stm
+
+clean-samd21:
+	$(MAKE) -C ports/atmel-samd BOARD=trinket_m0 clean
+
+clean-samd51:
+	$(MAKE) -C ports/atmel-samd BOARD=feather_m4_express clean
+
+clean-esp32s2:
+	$(MAKE) -C ports/esp32s2 BOARD=espressif_saola_1_wroom clean
+
+clean-litex:
+	$(MAKE) -C ports/litex BOARD=fomu clean
+
+clean-mimxrt10xx:
+	$(MAKE) -C ports/mimxrt10xx BOARD=feather_mimxrt1011 clean
+
+clean-nrf:
+	$(MAKE) -C ports/nrf BOARD=feather_nrf52840_express clean
+
+clean-stm:
+	$(MAKE) -C ports/stm BOARD=feather_stm32f405_express clean

README.rst

@@ -55,12 +55,12 @@ Contributing
 ------------
 
 See
-`CONTRIBUTING.md <https://github.com/adafruit/circuitpython/blob/master/CONTRIBUTING.md>`__
+`CONTRIBUTING.md <https://github.com/adafruit/circuitpython/blob/main/CONTRIBUTING.md>`__
 for full guidelines but please be aware that by contributing to this
 project you are agreeing to the `Code of
-Conduct <https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md>`__.
+Conduct <https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md>`__.
 Contributors who follow the `Code of
-Conduct <https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md>`__
+Conduct <https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md>`__
 are welcome to submit pull requests and they will be promptly reviewed
 by project admins. Please join the
 `Discord <https://adafru.it/discord>`__ too.
@@ -96,7 +96,6 @@ CircuitPython:
 
 -  Supports native USB on all boards, allowing file editing without special tools.
 -  Supports only SAMD21, SAMD51, nRF52840, CXD56, STM32F4 and i.MX RT ports.
--  Tracks MicroPython's releases (not master).
 -  Floats (aka decimals) are enabled for all builds.
 -  Error messages are translated into 10+ languages.
 -  Does not support concurrency within Python (including interrupts and threading). Some concurrency
@@ -211,8 +210,8 @@ The remaining port directories not listed above are in the repo to maintain comp
 
 `back to top <#circuitpython>`__
 
-.. |Build Status| image:: https://travis-ci.com/adafruit/circuitpython.svg?branch=master
-   :target: https://travis-ci.org/adafruit/circuitpython
+.. |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

conf.py

@@ -14,11 +14,13 @@
 # serve to show the default.
 
 import json
-import sys
+import logging
 import os
+import subprocess
+import sys
+import urllib.parse
 
 import recommonmark
-import subprocess
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -79,6 +81,9 @@
 autoapi_options = ['members', 'undoc-members', 'private-members', 'show-inheritance', 'special-members', 'show-module-summary']
 autoapi_template_dir = 'docs/autoapi/templates'
 autoapi_python_use_implicit_namespaces = True
+autoapi_root = "shared-bindings"
+
+redirects_file = 'docs/redirects.txt'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
@@ -374,5 +379,47 @@
                        "bus_device": ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),
                        "register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None)}
 
+# Adapted from sphinxcontrib-redirects
+from sphinx.builders import html as builders
+
+TEMPLATE = """<html>
+  <head><meta http-equiv="refresh" content="0; url=%s"/></head>
+</html>
+"""
+
+
+def generate_redirects(app):
+    path = os.path.join(app.srcdir, app.config.redirects_file)
+    if not os.path.exists(path):
+        logging.error("Could not find redirects file at '%s'" % path)
+        return
+
+    if not isinstance(app.builder, builders.StandaloneHTMLBuilder):
+        logging.warn("The 'sphinxcontib-redirects' plugin is only supported "
+                 "by the 'html' builder and subclasses. Skipping...")
+        logging.warn(f"Builder is {app.builder.name} ({type(app.builder)})")
+        return
+
+    with open(path) as redirects:
+        for line in redirects.readlines():
+            from_path, to_path = line.rstrip().split(' ')
+
+            logging.debug("Redirecting '%s' to '%s'" % (from_path, to_path))
+
+            from_path = os.path.splitext(from_path)[0] + ".html"
+            to_path_prefix = '..%s' % os.path.sep * (
+                len(from_path.split(os.path.sep)) - 1)
+            to_path = to_path_prefix + to_path
+
+            redirected_filename = os.path.join(app.builder.outdir, from_path)
+            redirected_directory = os.path.dirname(redirected_filename)
+            if not os.path.exists(redirected_directory):
+                os.makedirs(redirected_directory)
+
+            with open(redirected_filename, 'w') as f:
+                f.write(TEMPLATE % urllib.parse.quote(to_path, '#/'))
+
 def setup(app):
     app.add_css_file("customstyle.css")
+    app.add_config_value('redirects_file', 'redirects', 'env')
+    app.connect('builder-inited', generate_redirects)

docs/README.md

@@ -5,7 +5,7 @@ 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/master
+https://github.com/adafruit/circuitpython/tree/main
 
 Building the documentation locally
 ----------------------------------

docs/design_guide.rst

@@ -1,9 +1,11 @@
+.. role:: strike
+
 Design Guide
 ============
 
 This guide covers a variety of development practices for CircuitPython core and library APIs. These
 APIs are both `built-into CircuitPython
-<https://github.com/adafruit/circuitpython/tree/master/shared-bindings>`_ and those that are
+<https://github.com/adafruit/circuitpython/tree/main/shared-bindings>`_ and those that are
 `distributed on GitHub <https://github.com/search?utf8=%E2%9C%93&q=topic%3Acircuitpython&type=>`_
 and in the `Adafruit <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ and `Community
 <https://github.com/adafruit/CircuitPython_Community_Bundle/>`_ bundles. Consistency with these
@@ -46,6 +48,41 @@ not have the ``adafruit_`` module or package prefix.
 
 Both should have the CircuitPython repository topic on GitHub.
 
+Terminology
+-----------
+
+As our Code of Conduct states, we strive to use "welcoming and inclusive
+language." Whether it is in documentation or in code, the words we use matter.
+This means we disfavor language that due to historical and social context can
+make community members and potential community members feel unwelcome.
+
+There are specific terms to avoid except where technical limitations require it.
+While specific cases may call for other terms, consider using these suggested
+terms first:
+
++--------------------+---------------------+
+| Preferred          | Deprecated          |
++====================+=====================+
+| Main (device)      | :strike:`Master`    |
++--------------------+---------------------+
+| Peripheral         | :strike:`Slave`     |
++--------------------+                     +
+| Sensor             |                     |
++--------------------+                     +
+| Secondary (device) |                     |
++--------------------+---------------------+
+| Denylist           | :strike:`Blacklist` |
++--------------------+---------------------+
+| Allowlist          | :strike:`Whitelist` |
++--------------------+---------------------+
+
+Note that "technical limitations" refers e.g., to the situation where an
+upstream library or URL has to contain those substrings in order to work.
+However, when it comes to documentation and the names of parameters and
+properties in CircuitPython, we will use alternate terms even if this breaks
+tradition with past practice.
+
+
 .. _lifetime-and-contextmanagers:
 
 Lifetime and ContextManagers