Merge remote-tracking branch 'upstream/master' into doc-ja

# Conflicts: # docs/templates/layout.html
MinoruInachi · Oct 6, 2023 · 691bd8b · 691bd8b
2 parents 48fc900 + 5232847
commit 691bd8b
Show file tree

Hide file tree

Showing 251 changed files with 2,126 additions and 1,252 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -1,3 +1,6 @@
+# all: Fix various spelling mistakes found by codespell 2.2.6.
+cf490a70917a1b2d38ba9b58e763e0837d0f7ca7
+
 # all: Fix spelling mistakes based on codespell check.
 b1229efbd1509654dec6053865ab828d769e29db
 

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,6 +1,7 @@
 name: Build docs
 
 on:
+  push:
   pull_request:
     paths:
       - docs/**
@@ -17,6 +18,6 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
     - name: Install Python packages
-      run: pip install Sphinx
+      run: pip install -r docs/requirements.txt
     - name: Build docs
       run: make -C docs/ html
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![CI badge](https://github.com/micropython/micropython/workflows/unix%20port/badge.svg)](https://github.com/micropython/micropython/actions?query=branch%3Amaster+event%3Apush) [![codecov](https://codecov.io/gh/micropython/micropython/branch/master/graph/badge.svg?token=I92PfD05sD)](https://codecov.io/gh/micropython/micropython)
+[![Unix CI badge](https://github.com/micropython/micropython/actions/workflows/ports_unix.yml/badge.svg)](https://github.com/micropython/micropython/actions?query=branch%3Amaster+event%3Apush) [![STM32 CI badge](https://github.com/micropython/micropython/actions/workflows/ports_stm32.yml/badge.svg)](https://github.com/micropython/micropython/actions?query=branch%3Amaster+event%3Apush) [![Docs CI badge](https://github.com/micropython/micropython/actions/workflows/docs.yml/badge.svg)](https://docs.micropython.org/) [![codecov](https://codecov.io/gh/micropython/micropython/branch/master/graph/badge.svg?token=I92PfD05sD)](https://codecov.io/gh/micropython/micropython)
 
 The MicroPython project
 =======================

diff --git a/docs/conf.py b/docs/conf.py
@@ -21,10 +21,12 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('.'))
 
-# The members of the html_context dict are available inside topindex.html
+# The MICROPY_VERSION env var should be "vX.Y.Z" (or unset).
 micropy_version = os.getenv('MICROPY_VERSION') or 'latest'
 micropy_all_versions = (os.getenv('MICROPY_ALL_VERSIONS') or 'latest').split(',')
 url_pattern = '%s/en/%%s' % (os.getenv('MICROPY_URL_PREFIX') or '/',)
+
+# The members of the html_context dict are available inside topindex.html
 html_context = {
     'cur_version':micropy_version,
     'all_versions':[

diff --git a/docs/develop/gettingstarted.rst b/docs/develop/gettingstarted.rst
@@ -245,7 +245,7 @@ that you use a virtual environment:
 
    $ python3 -m venv env
    $ source env/bin/activate
-   $ pip install sphinx
+   $ pip install -r docs/requirements.txt
 
 Navigate to the ``docs`` directory:
 

diff --git a/docs/esp32/quickref.rst b/docs/esp32/quickref.rst
@@ -101,7 +101,7 @@ A useful function for connecting to your local WiFi network is::
         print('network config:', wlan.ifconfig())
 
 Once the network is established the :mod:`socket <socket>` module can be used
-to create and use TCP/UDP sockets as usual, and the ``urequests`` module for
+to create and use TCP/UDP sockets as usual, and the ``requests`` module for
 convenient HTTP requests.
 
 After a call to ``wlan.connect()``, the device will by default retry to connect

diff --git a/docs/library/espnow.rst b/docs/library/espnow.rst
@@ -287,7 +287,7 @@ after reboot/reset). This reduces the reliability of receiving ESP-NOW messages
 
 .. method:: ESPNow.irecv([timeout_ms])
 
-    Works like `ESPNow.recv()` but will re-use internal bytearrays to store the
+    Works like `ESPNow.recv()` but will reuse internal bytearrays to store the
     return values: ``[mac, msg]``, so that no new memory is allocated on each
     call.
 

diff --git a/docs/library/network.rst b/docs/library/network.rst
@@ -188,6 +188,11 @@ The following are functions available in the network module.
     during connection. For this reason, you must set the hostname before
     activating/connecting your network interfaces.
 
+    The length of the hostname is limited to 32 characters.
+    :term:`MicroPython ports <MicroPython port>` may choose to set a lower
+    limit for memory reasons. If the given name does not fit, a `ValueError`
+    is raised.
+
     The default hostname is typically the name of the board.
 
 .. function:: phy_mode([mode])

diff --git a/docs/library/wm8960.rst b/docs/library/wm8960.rst
@@ -251,7 +251,7 @@ controlling its operation:
 
 .. method:: WM8960.expand_3d(level)
 
-    Enable Stereo 3D exansion.  *level* is a number between 0 and 15.
+    Enable Stereo 3D expansion.  *level* is a number between 0 and 15.
     A value of 0 disables the expansion.
 
 .. method:: WM8960.mono(active)

diff --git a/docs/locale/ja/LC_MESSAGES/develop.po b/docs/locale/ja/LC_MESSAGES/develop.po
@@ -10,8 +10,8 @@ msgid ""
 msgstr ""
 "Project-Id-Version: MicroPython latest\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-09-22 23:11+0900\n"
-"PO-Revision-Date: 2023-09-22 23:17+0900\n"
+"POT-Creation-Date: 2023-10-06 20:50+0900\n"
+"PO-Revision-Date: 2023-10-06 21:03+0900\n"
 "Last-Translator: Minoru Inachi\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
@@ -1655,7 +1655,7 @@ msgstr ""
 msgid ""
 "$ python3 -m venv env\n"
 "$ source env/bin/activate\n"
-"$ pip install sphinx"
+"$ pip install -r docs/requirements.txt"
 msgstr ""
 
 #: ../../develop/gettingstarted.rst:250

diff --git a/docs/locale/ja/LC_MESSAGES/esp32.po b/docs/locale/ja/LC_MESSAGES/esp32.po
@@ -10,8 +10,8 @@ msgid ""
 msgstr ""
 "Project-Id-Version: MicroPython latest\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-09-22 23:11+0900\n"
-"PO-Revision-Date: 2023-09-22 23:53+0900\n"
+"POT-Creation-Date: 2023-10-06 20:50+0900\n"
+"PO-Revision-Date: 2023-10-06 21:00+0900\n"
 "Last-Translator: Minoru Inachi\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -377,12 +377,12 @@ msgstr ""
 #: ../../esp32/quickref.rst:103
 msgid ""
 "Once the network is established the :mod:`socket <socket>` module can be "
-"used to create and use TCP/UDP sockets as usual, and the ``urequests`` "
+"used to create and use TCP/UDP sockets as usual, and the ``requests`` "
 "module for convenient HTTP requests."
 msgstr ""
 "ネットワークが確立されると :mod:`socket <socket>` モジュールを使って、"
 "通常どおり TCP/UDP ソケットを作成して使用できます。"
-"HTTP リクエストするには ``urequests`` モジュールを使うと便利です。"
+"HTTP リクエストするには ``requests`` モジュールを使うと便利です。"
 
 #: ../../esp32/quickref.rst:107
 msgid ""