Welcome to MicroPython-Stubber!

Contents:

• Boost MicroPython Productivity in VS Code
  • Licensing
• Quick Start – Contributing stubs for a new board
  • What are stubs, and why do I need them?
  • Prerequisites
  • Step 1 – Install micropython-stubber
  • Step 2 – Create a working directory
  • Step 3 – Initialize the workspace
  • Step 4 (optional) – Generate doc stubs
  • Step 5 (optional) – Generate frozen stubs
  • Step 6 – Generate firmware stubs from a connected device
  • Step 7 – Merge and build the stub package
  • Step 8 – Verify the stubs locally
  • Step 9 – Contribute your stubs
  • Full workflow at a glance
  • Next steps
• Approach to collecting stub information
  • Stub collection process
  • Firmware stubs (formerly MCU stubs) format and limitations
  • Stub naming convention
• Command Line Interface
  • stubber
• Using MicroPython Stubber
  • Command Reference
  • Quick Start
  • Custom MicroPython Builds
• Generating Stubs for Custom MicroPython Builds
  • Prerequisites
  • Enhanced CLI Commands
  • Scenario-Based Workflows
  • Scenario 1: Working with a Fork
  • Scenario 2: Working with a Pull Request
  • Scenario 3: Working with Local Modifications
  • Scenario 4: Complete Workflow for Custom Firmware
  • Working Without Version Tags
  • Tips and Best Practices
  • Troubleshooting
  • Getting Help
  • See Also
• Create Firmware Stubs (formerly MCU stubs)
  • Quick Examples
  • Manual script usage (legacy / advanced)
  • Generating Stubs for a specific Firmware
  • Downloading the files
  • Custom firmware
  • The Unstubbables
• 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
• Bulk Stubber
  • Command Options
  • What The Command Actually Does
  • VFS Mounting Behavior
  • Error Handling and Retries
  • Typical Usage
  • Notes
• Overview of Stubs
  • Firmware and libraries
  • Included custom stubs
• References
  • Inspiration
  • Documentation on Type hints
• Documentation
• Glossary
  • General Terms
  • Stub-Related Terms
  • Tools and Commands
  • File Extensions and Formats
  • MicroPython-Specific Terms
  • Development Workflow Terms
  • Configuration Terms
  • Error and Debugging Terms

Development:

• Developing
• Testing
• Publishing
• API Reference

api/index.rst

# Indices and tables

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