Welcome to MicroPython-Stubber!

Contents:

• Boost MicroPython productivity in VSCode
  • Licensing
• Approach to collecting stub information
  • Stub collection process
  • Firmware Stubs format and limitations
  • Stub naming convention
• stubber
  • build
  • clone
  • enrich
  • get-core
  • get-docstubs
  • get-frozen
  • get-lobo
  • make-variants
  • merge
  • minify
  • publish
  • show-config
  • stub
  • switch
  • update-fallback
  • update-module-list
  • --version
  • -v, --verbose
• Using Micropython stubber
  • Manual configuration
  • using micropython-stubber
  • Using micropy-cli
• Create Firmware Stubs
  • Running the script
  • Generating Stubs for a specific Firmware
  • Downloading the files
  • Custom firmware
  • The Unstubbables
• Using Createstub
  • Use MIP to install createstubs on a MCU board
  • Install createstubs
  • run createstubs
  • low memory devices
  • format the stubs and generate the .pyi files
• Createstub Variants
  • board/createstubs.py
  • createstubs_mem.py
  • Optimisations
• CPython and Frozen modules
  • Frozen Modules
  • Collect Frozen Stubs (micropython)
  • Postprocessing
• Documentation Stubs
  • What / Why
  • How docstubs are generated
• Repo structure
  • This and sister repos
  • Structure of this repo
  • Naming Convention and Stub folder structure
  • Create a symbolic link
• Codemods
  • What are codemods
  • Provided codemods
  • add_comment.AddComment codemod
  • How to run a codemode from the commandline
  • Where are codemods used
• PowerShell Scripts
  • bulk_stubber.ps1
• Overview of Stubs
  • Firmware and libraries
  • Included custom stubs
• References
  • Inspiration
  • Documentation on Type hints
• Documentation

Development:

• Developing
• Testing
• Publishing
• API Reference

api/index.rst

# Indices and tables

- {ref}`genindex`
- {ref}`modindex`
- {ref}`search`