Merge branch 'main' of https://github.com/adafruit/circuitpython into ci_check_vid_pid

Author: sommersoft

.github/workflows/build.yml

@@ -16,14 +16,11 @@ 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
     - name: Set up Python 3.8
@@ -66,8 +63,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
+    - uses: actions/upload-artifact@v2
+      with:
+        name: docs
+        path: _build/html
     - name: Translations
       run: make check-translate
     - name: New boards check
@@ -112,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
@@ -207,6 +209,7 @@ jobs:
         - "monster_m4sk"
         - "ndgarage_ndbit6"
         - "nfc_copy_cat"
+        - "nice_nano"
         - "nucleo_f746zg"
         - "nucleo_f767zi"
         - "nucleo_h743zi_2"
@@ -287,14 +290,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
@@ -338,14 +338,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
@@ -378,14 +375,11 @@ jobs:
       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

@@ -18,17 +18,16 @@ jobs:
         python-version: 3.8
     - name: Install deps
       run: |
-        pip install requests sh click 
+        pip install requests sh click
     - name: Versions
       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

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: Copyright (c) 2019 Anthony Sottile
+#
+# SPDX-License-Identifier: MIT
+
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-python@v1
+    - name: set PY
+      run: echo "::set-env name=PY::$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')"
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pre-commit
+        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+    - uses: pre-commit/[email protected]

.gitignore

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

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        exclude: '^(tests/.*\.exp|tests/cmdline/.*|tests/.*/data/.*)'
+    -   id: trailing-whitespace
+        exclude: '^(tests/.*\.exp|tests/cmdline/.*|tests/.*/data/.*)'

BUILDING.md

@@ -1,7 +1,7 @@
 
 # Building CircuitPython
 
-Welcome to CircuitPython!  
+Welcome to CircuitPython!
 
 This document is a quick-start guide only.
 
@@ -28,7 +28,7 @@ This project has a bunch of git submodules.  You will need to update them regula
 As part of the build process, mpy-cross is needed to compile .py files into .mpy files.
 To compile (or recompile) mpy-cross:
 
-    make -C mpy-cross 
+    make -C mpy-cross
 
 # Building
 
@@ -68,7 +68,7 @@ A successful run will say something like
 
 # Debugging
 
-The easiest way to debug CircuitPython on hardware is with a JLink device, JLinkGDBServer, and an appropriate GDB.   
+The easiest way to debug CircuitPython on hardware is with a JLink device, JLinkGDBServer, and an appropriate GDB.
 Instructions can be found at https://learn.adafruit.com/debugging-the-samd21-with-gdb
 
 If using JLink, you'll need both the `JLinkGDBServer` and `arm-none-eabi-gdb` running.

CODE_OF_CONDUCT.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
+SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
 # Adafruit Community Code of Conduct
 
 ## Our Pledge
@@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include:
 
 The goal of the standards and moderation guidelines outlined here is to build
 and maintain a respectful community. We ask that you don’t just aim to be
-"technically unimpeachable", but rather try to be your best self. 
+"technically unimpeachable", but rather try to be your best self.
 
 We value many things beyond technical expertise, including collaboration and
 supporting others within our community. Providing a positive experience for
@@ -74,9 +80,9 @@ You may report in the following ways:
 In any situation, you may send an email to <[email protected]>.
 
 On the Adafruit Discord, you may send an open message from any channel
-to all Community Moderators by tagging @community moderators. You may 
-also send an open message from any channel, or a direct message to 
-@kattni#1507, @tannewt#4653, @danh#1614, @cater#2442, 
+to all Community Moderators by tagging @community moderators. You may
+also send an open message from any channel, or a direct message to
+@kattni#1507, @tannewt#4653, @danh#1614, @cater#2442,
 @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
 
 Email and direct message reports will be kept confidential.

Makefile

@@ -202,22 +202,37 @@ pseudoxml:
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 
 # phony target so we always run
+.PHONY: all-source
 all-source:
 
 locale/circuitpython.pot: all-source
 	find $(TRANSLATE_SOURCES) -iname "*.c" -print | (LC_ALL=C sort) | xgettext -f- -L C -s --add-location=file --keyword=translate -o circuitpython.pot -p locale
 
+# Historically, `make translate` updated the .pot file and ran msgmerge.
+# However, this was a frequent source of merge conflicts.  Weblate can perform
+# msgmerge, so make translate merely update the translation template file.
+.PHONY: translate
 translate: locale/circuitpython.pot
+
+# Note that normally we rely on weblate to perform msgmerge.  This reduces the
+# chance of a merge conflict between developer changes (that only add and
+# remove source strings) and weblate changes (that only add and remove
+# translated strings from po files).  However, in case this is legitimately
+# needed we preserve a rule to do it.
+.PHONY: msgmerge
+msgmerge:
 	for po in $(shell ls locale/*.po); do msgmerge -U $$po -s --no-fuzzy-matching --add-location=file locale/circuitpython.pot; done
 
 merge-translate:
 	git merge HEAD 1>&2 2> /dev/null; test $$? -eq 128
 	rm locale/*~ || true
-	git checkout --ours -- locale/*
+	git checkout --theirs -- locale/*
 	make translate
 
-check-translate: locale/circuitpython.pot $(wildcard locale/*.po)
-	$(PYTHON) tools/check_translations.py $^
+.PHONY: check-translate
+check-translate:
+	find $(TRANSLATE_SOURCES) -iname "*.c" -print | (LC_ALL=C sort) | xgettext -f- -L C -s --add-location=file --keyword=translate -o circuitpython.pot.tmp -p locale
+	$(PYTHON) tools/check_translations.py locale/circuitpython.pot.tmp locale/circuitpython.pot; status=$$?; rm -f locale/circuitpython.pot.tmp; exit $$status
 
 stubs:
 	@mkdir -p circuitpython-stubs

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,46 @@
                        "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):
+        app.info("Could not find redirects file at '%s'" % path)
+        return
+
+    if not type(app.builder) == builders.StandaloneHTMLBuilder:
+        logging.warn("The 'sphinxcontib-redirects' plugin is only supported "
+                 "by the 'html' builder. Skipping...")
+        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

@@ -34,10 +34,10 @@ All commands will, by default, run with `-E` (forces a rebuild from scratch of d
 
     # 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"