From 145c470701092617e7600e00634168e03524ea7f Mon Sep 17 00:00:00 2001 From: Josverl Date: Tue, 27 Aug 2024 05:03:06 +0000 Subject: [PATCH] Update stubs documentation Signed-off-by: Jos Verlinde --- .vscode/settings.json | 24 ++++- docs/index.md | 2 +- docs/modules_pypi_body.md | 174 ++++++++++++++++++------------------ docs/packages.md | 2 +- docs/parkinglot.md | 19 ---- docs/report_pypi_modules.py | 6 +- 6 files changed, 114 insertions(+), 113 deletions(-) delete mode 100644 docs/parkinglot.md diff --git a/.vscode/settings.json b/.vscode/settings.json index bb33b292e..38c0c2390 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,43 +23,64 @@ "titleBar.inactiveForeground": "#e7e7e799" }, "peacock.color": "#215732", + // To ignore ALL CAPS in all files + "cSpell.ignoreRegExpList": [ + "/\\b[A-Z]+\\b/g" + ], "cSpell.words": [ + "ADAFRUIT", "builtins", "clearcache", "colorstubs", "contextlib", "cpython", + "dataframe", "debugpy", "docstrings", "docstubs", "firmwares", "flatgithub", "flatview", + "flowui", + "GARATRONIC", "genindex", "josverl", "Loboris", + "LOLIN", "LVGL", "maxdepth", "microbit", + "micropico", "modindex", + "modulename", "mpremote", "mypy", "MYPYPATH", "Pico", + "PICOLIPO", + "PIMORONI", "PSRAM", "pwsh", + "PYBD", + "pyboard", + "PYBSTICK", + "PYBV", "pycopy", "pylance", "pylint", "pylintrc", + "pypi", "pyproject", "pyright", "pyrightconfig", + "renesas", "SAMD", + "SEEED", "spiram", "stdlib", "stinos", "stubgen", + "TINYPICO", "toctree", "Traceback", "typeshed", @@ -82,5 +103,6 @@ "[python]": { "editor.defaultFormatter": "ms-python.black-formatter" }, - "python.formatting.provider": "none" + "python.formatting.provider": "none", + "python.analysis.supportRestructuredText": true } \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index e25c218b3..72d9c053f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,7 +37,7 @@ qa_testing.md ```{toctree} :caption: 'Stub index' -:maxdepth: 2 +:maxdepth: 3 packages.md package_flatview.md firmware_grp.md diff --git a/docs/modules_pypi_body.md b/docs/modules_pypi_body.md index dab107293..244b5b456 100644 --- a/docs/modules_pypi_body.md +++ b/docs/modules_pypi_body.md @@ -1,62 +1,75 @@ -### MicroPython v1.17.0 +### MicroPython v1.23.0 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.17.0.*` -| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.17.0.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.17.0.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.17.0.*` +| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.23.0.*` +| esp32 | ESP32_GENERIC_C3 | micropython-esp32-esp32_generic_c3-stubs | `pip install -U micropython-esp32-esp32_generic_c3-stubs==1.23.0.*` +| esp32 | ESP32_GENERIC_S3 | micropython-esp32-esp32_generic_s3-stubs | `pip install -U micropython-esp32-esp32_generic_s3-stubs==1.23.0.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.23.0.*` +| esp8266 | ESP8266_GENERIC | micropython-esp8266-esp8266_generic-stubs | `pip install -U micropython-esp8266-esp8266_generic-stubs==1.23.0.*` +| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.23.0.*` +| rp2 | ARDUINO_NANO_RP2040_CONNECT | micropython-rp2-arduino_nano_rp2040_connect-stubs | `pip install -U micropython-rp2-arduino_nano_rp2040_connect-stubs==1.23.0.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.23.0.*` +| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.23.0.*` +| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.23.0.*` +| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.23.0.*` +| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.23.0.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.23.0.*` +| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.23.0.*` -### MicroPython v1.18.0 +### MicroPython v1.22.2 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.18.0.*` -| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.18.0.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.18.0.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.18.0.*` +| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.22.2.*` +| esp32 | ESP32_GENERIC_C3 | micropython-esp32-esp32_generic_c3-stubs | `pip install -U micropython-esp32-esp32_generic_c3-stubs==1.22.2.*` +| esp32 | ESP32_GENERIC_S3 | micropython-esp32-esp32_generic_s3-stubs | `pip install -U micropython-esp32-esp32_generic_s3-stubs==1.22.2.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.22.2.*` +| esp8266 | ESP8266_GENERIC | micropython-esp8266-esp8266_generic-stubs | `pip install -U micropython-esp8266-esp8266_generic-stubs==1.22.2.*` +| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.22.2.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.22.2.*` +| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.22.2.*` +| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.22.2.*` +| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.22.2.*` +| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.22.2.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.22.2.*` +| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.22.2.*` -### MicroPython v1.19.1 +### MicroPython v1.22.1 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.19.1.*` -| esp32 | GENERIC_S3 | micropython-esp32-generic_s3-stubs | `pip install -U micropython-esp32-generic_s3-stubs==1.19.1.*` -| esp32 | GENERIC_SPIRAM | micropython-esp32-generic_spiram-stubs | `pip install -U micropython-esp32-generic_spiram-stubs==1.19.1.*` -| esp32 | S3 | micropython-esp32-s3-stubs | `pip install -U micropython-esp32-s3-stubs==1.19.1.*` -| esp32 | UM_TINYPICO | micropython-esp32-um_tinypico-stubs | `pip install -U micropython-esp32-um_tinypico-stubs==1.19.1.*` -| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.19.1.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.19.1.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.19.1.*` +| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.22.1.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.22.1.*` +| rp2 | ARDUINO_NANO_RP2040_CONNECT | micropython-rp2-arduino_nano_rp2040_connect-stubs | `pip install -U micropython-rp2-arduino_nano_rp2040_connect-stubs==1.22.1.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.22.1.*` +| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.22.1.*` +| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.22.1.*` +| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.22.1.*` +| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.22.1.*` -### MicroPython v1.20.0 +### MicroPython v1.22.0 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.20.0.*` -| esp32 | GENERIC_OTA | micropython-esp32-generic_ota-stubs | `pip install -U micropython-esp32-generic_ota-stubs==1.20.0.*` -| esp32 | GENERIC_S3 | micropython-esp32-generic_s3-stubs | `pip install -U micropython-esp32-generic_s3-stubs==1.20.0.*` -| esp32 | OTA | micropython-esp32-ota-stubs | `pip install -U micropython-esp32-ota-stubs==1.20.0.*` -| esp32 | S3 | micropython-esp32-s3-stubs | `pip install -U micropython-esp32-s3-stubs==1.20.0.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.20.0.*` -| rp2 | PICO | micropython-rp2-pico-stubs | `pip install -U micropython-rp2-pico-stubs==1.20.0.*` -| rp2 | PICO_W | micropython-rp2-pico_w-stubs | `pip install -U micropython-rp2-pico_w-stubs==1.20.0.*` -| samd | ADAFRUIT_FEATHER_M4_EXPRESS | micropython-samd-adafruit_feather_m4_express-stubs | `pip install -U micropython-samd-adafruit_feather_m4_express-stubs==1.20.0.*` -| samd | ADAFRUIT_ITSYBITSY_M4_EXPRESS | micropython-samd-adafruit_itsybitsy_m4_express-stubs | `pip install -U micropython-samd-adafruit_itsybitsy_m4_express-stubs==1.20.0.*` -| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.20.0.*` -| samd | MINISAM_M4 | micropython-samd-minisam_m4-stubs | `pip install -U micropython-samd-minisam_m4-stubs==1.20.0.*` -| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.20.0.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.20.0.*` -| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.20.0.*` -| unix | GENERIC | micropython-unix-stubs | `pip install -U micropython-unix-stubs==1.20.0.*` -| windows | GENERIC | micropython-windows-stubs | `pip install -U micropython-windows-stubs==1.20.0.*` +| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.22.0.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.22.0.*` +| rp2 | ARDUINO_NANO_RP2040_CONNECT | micropython-rp2-arduino_nano_rp2040_connect-stubs | `pip install -U micropython-rp2-arduino_nano_rp2040_connect-stubs==1.22.0.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.22.0.*` +| rp2 | PIMORONI_PICOLIPO_16MB | micropython-rp2-pimoroni_picolipo_16mb-stubs | `pip install -U micropython-rp2-pimoroni_picolipo_16mb-stubs==1.22.0.*` +| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.22.0.*` +| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.22.0.*` +| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.22.0.*` +| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.22.0.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.22.0.*` +| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.22.0.*` @@ -83,75 +96,62 @@ -### MicroPython v1.22.0 +### MicroPython v1.20.0 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.22.0.*` -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.22.0.*` -| rp2 | ARDUINO_NANO_RP2040_CONNECT | micropython-rp2-arduino_nano_rp2040_connect-stubs | `pip install -U micropython-rp2-arduino_nano_rp2040_connect-stubs==1.22.0.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.22.0.*` -| rp2 | PIMORONI_PICOLIPO_16MB | micropython-rp2-pimoroni_picolipo_16mb-stubs | `pip install -U micropython-rp2-pimoroni_picolipo_16mb-stubs==1.22.0.*` -| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.22.0.*` -| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.22.0.*` -| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.22.0.*` -| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.22.0.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.22.0.*` -| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.22.0.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.20.0.*` +| esp32 | GENERIC_OTA | micropython-esp32-generic_ota-stubs | `pip install -U micropython-esp32-generic_ota-stubs==1.20.0.*` +| esp32 | GENERIC_S3 | micropython-esp32-generic_s3-stubs | `pip install -U micropython-esp32-generic_s3-stubs==1.20.0.*` +| esp32 | OTA | micropython-esp32-ota-stubs | `pip install -U micropython-esp32-ota-stubs==1.20.0.*` +| esp32 | S3 | micropython-esp32-s3-stubs | `pip install -U micropython-esp32-s3-stubs==1.20.0.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.20.0.*` +| rp2 | PICO | micropython-rp2-pico-stubs | `pip install -U micropython-rp2-pico-stubs==1.20.0.*` +| rp2 | PICO_W | micropython-rp2-pico_w-stubs | `pip install -U micropython-rp2-pico_w-stubs==1.20.0.*` +| samd | ADAFRUIT_FEATHER_M4_EXPRESS | micropython-samd-adafruit_feather_m4_express-stubs | `pip install -U micropython-samd-adafruit_feather_m4_express-stubs==1.20.0.*` +| samd | ADAFRUIT_ITSYBITSY_M4_EXPRESS | micropython-samd-adafruit_itsybitsy_m4_express-stubs | `pip install -U micropython-samd-adafruit_itsybitsy_m4_express-stubs==1.20.0.*` +| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.20.0.*` +| samd | MINISAM_M4 | micropython-samd-minisam_m4-stubs | `pip install -U micropython-samd-minisam_m4-stubs==1.20.0.*` +| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.20.0.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.20.0.*` +| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.20.0.*` +| unix | GENERIC | micropython-unix-stubs | `pip install -U micropython-unix-stubs==1.20.0.*` +| windows | GENERIC | micropython-windows-stubs | `pip install -U micropython-windows-stubs==1.20.0.*` -### MicroPython v1.22.1 +### MicroPython v1.19.1 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.22.1.*` -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.22.1.*` -| rp2 | ARDUINO_NANO_RP2040_CONNECT | micropython-rp2-arduino_nano_rp2040_connect-stubs | `pip install -U micropython-rp2-arduino_nano_rp2040_connect-stubs==1.22.1.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.22.1.*` -| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.22.1.*` -| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.22.1.*` -| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.22.1.*` -| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.22.1.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.19.1.*` +| esp32 | GENERIC_S3 | micropython-esp32-generic_s3-stubs | `pip install -U micropython-esp32-generic_s3-stubs==1.19.1.*` +| esp32 | GENERIC_SPIRAM | micropython-esp32-generic_spiram-stubs | `pip install -U micropython-esp32-generic_spiram-stubs==1.19.1.*` +| esp32 | S3 | micropython-esp32-s3-stubs | `pip install -U micropython-esp32-s3-stubs==1.19.1.*` +| esp32 | UM_TINYPICO | micropython-esp32-um_tinypico-stubs | `pip install -U micropython-esp32-um_tinypico-stubs==1.19.1.*` +| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.19.1.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.19.1.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.19.1.*` -### MicroPython v1.22.2 +### MicroPython v1.18.0 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.22.2.*` -| esp32 | ESP32_GENERIC_C3 | micropython-esp32-esp32_generic_c3-stubs | `pip install -U micropython-esp32-esp32_generic_c3-stubs==1.22.2.*` -| esp32 | ESP32_GENERIC_S3 | micropython-esp32-esp32_generic_s3-stubs | `pip install -U micropython-esp32-esp32_generic_s3-stubs==1.22.2.*` -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.22.2.*` -| esp8266 | ESP8266_GENERIC | micropython-esp8266-esp8266_generic-stubs | `pip install -U micropython-esp8266-esp8266_generic-stubs==1.22.2.*` -| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.22.2.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.22.2.*` -| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.22.2.*` -| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.22.2.*` -| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.22.2.*` -| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.22.2.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.22.2.*` -| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.22.2.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.18.0.*` +| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.18.0.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.18.0.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.18.0.*` -### MicroPython v1.23.0 +### MicroPython v1.17.0 | Port | Board | Package | pip install | |------|-------|---------| ------------| -| esp32 | ESP32_GENERIC | micropython-esp32-esp32_generic-stubs | `pip install -U micropython-esp32-esp32_generic-stubs==1.23.0.*` -| esp32 | ESP32_GENERIC_C3 | micropython-esp32-esp32_generic_c3-stubs | `pip install -U micropython-esp32-esp32_generic_c3-stubs==1.23.0.*` -| esp32 | ESP32_GENERIC_S3 | micropython-esp32-esp32_generic_s3-stubs | `pip install -U micropython-esp32-esp32_generic_s3-stubs==1.23.0.*` -| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.23.0.*` -| esp8266 | ESP8266_GENERIC | micropython-esp8266-esp8266_generic-stubs | `pip install -U micropython-esp8266-esp8266_generic-stubs==1.23.0.*` -| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.23.0.*` -| rp2 | ARDUINO_NANO_RP2040_CONNECT | micropython-rp2-arduino_nano_rp2040_connect-stubs | `pip install -U micropython-rp2-arduino_nano_rp2040_connect-stubs==1.23.0.*` -| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.23.0.*` -| rp2 | RPI_PICO | micropython-rp2-rpi_pico-stubs | `pip install -U micropython-rp2-rpi_pico-stubs==1.23.0.*` -| rp2 | RPI_PICO_W | micropython-rp2-rpi_pico_w-stubs | `pip install -U micropython-rp2-rpi_pico_w-stubs==1.23.0.*` -| samd | GENERIC | micropython-samd-stubs | `pip install -U micropython-samd-stubs==1.23.0.*` -| samd | SEEED_WIO_TERMINAL | micropython-samd-seeed_wio_terminal-stubs | `pip install -U micropython-samd-seeed_wio_terminal-stubs==1.23.0.*` -| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.23.0.*` -| stm32 | PYBV11 | micropython-stm32-pybv11-stubs | `pip install -U micropython-stm32-pybv11-stubs==1.23.0.*` +| esp32 | GENERIC | micropython-esp32-stubs | `pip install -U micropython-esp32-stubs==1.17.0.*` +| esp8266 | GENERIC | micropython-esp8266-stubs | `pip install -U micropython-esp8266-stubs==1.17.0.*` +| rp2 | GENERIC | micropython-rp2-stubs | `pip install -U micropython-rp2-stubs==1.17.0.*` +| stm32 | GENERIC | micropython-stm32-stubs | `pip install -U micropython-stm32-stubs==1.17.0.*` diff --git a/docs/packages.md b/docs/packages.md index 8c00624e0..2572a19d0 100644 --- a/docs/packages.md +++ b/docs/packages.md @@ -49,4 +49,4 @@ This includes stubs from the following MicroPython families: - [ulab native modules](ulab-stubs) -An up-to-date list of all current Firmwares, ports and boards is listed on the [**Firmwares page**](all-stubs) +An up-to-date list of all partial and intermediate stubs for different families, ports and boards is listed on the [**Firmwares page**](all-stubs) diff --git a/docs/parkinglot.md b/docs/parkinglot.md deleted file mode 100644 index d1148ee55..000000000 --- a/docs/parkinglot.md +++ /dev/null @@ -1,19 +0,0 @@ -.. orphan :: - -# Parkinglot - -#### 5. Configure Your IDE - -Configure your IDE (or other tools) to use the stubs: - -- If using a virtual environment, most tools will automatically detect the stubs. -- If not using a virtual environment, configure the tool with the stubs’ location (unless it defaults to `typings`). -- Specify the Python language version (MicroPython is based on Python 3.5 with some features from later versions). - -And that’s it! - -You’re all set to write MicroPython code with the help of these powerful stubs. - -For more details, check out the [MicroPython Stubs documentation](https://micropython-stubs.readthedocs.io/). You can also explore the [full overview of all stubs](https://micropython-stubs.readthedocs.io/). 😊 - -## Stubber Prosessing order diff --git a/docs/report_pypi_modules.py b/docs/report_pypi_modules.py index 2771e9375..cc8973226 100644 --- a/docs/report_pypi_modules.py +++ b/docs/report_pypi_modules.py @@ -33,11 +33,9 @@ def report_to_md(df_pypi, template, dest_md): # iterate over each group in the grouped dataframe for version, group in grouped: # render the template with the group data - rendered_module = template.render( - version=version, modules=group.to_dict(orient="records") - ) + rendered_module = template.render(version=version, modules=group.to_dict(orient="records")) # append the rendered module to the list - rendered_modules.append(rendered_module) + rendered_modules.insert(0, rendered_module) # join the rendered modules into a single string rendered_modules_str = "\n".join(rendered_modules)