Micropython-Stubber
doc_updates
Contents:
Boost MicroPython productivity in VSCode
Approach to collecting stub information
stubber
Using stubs
VSCode and Pylint configuration
Create Firmware Stubs
createstub variants
CPython and Frozen modules
Documentation Stubs
Repo structure
PowerShell Scripts
Overview of Stubs
References
Documentation
versions and changes
Changelog
V1.6.9
v1.6.8
v1.6.7
v1.6.6
v1.6.4
v1.6.3 minor cleanups
v1.6.0
Naming convention
Use Poetry
createsubs v1.5.4
improve docstubs
Tests
createstubs: v1.5.1
TO-DO (provisional)
Upstream Documentation
Development:
Developing
Testing
API Reference
Micropython-Stubber
Welcome to MicroPython-Stubber!
Edit on GitHub
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
merge
minify
publish
show-config
stub
switch
update-fallback
update-module-list
--version
-v, --verbose
Using stubs
Manual configuration
using micropython-stubber
Using micropy-cli
VSCode and Pylint configuration
Recommended order of the stubs in your config:
Relevant VSCode settings
pylint
Microsoft Python Language Server settings - Deprecated
Create Firmware Stubs
Running the script
Generating Stubs for a specific Firmware
Downloading the files
Custom firmware
The Unstubbables
createstub variants
board/createstubs.py
board/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
PowerShell Scripts
bulk_stubber.ps1
Overview of Stubs
Firmware and libraries
Included custom stubs
References
Inspiration
Documentation on Type hints
Documentation
versions and changes
Changelog
V1.6.9
v1.6.8
v1.6.7
v1.6.6
v1.6.4
v1.6.3 minor cleanups
v1.6.0
Naming convention
Use Poetry
createsubs v1.5.4
improve docstubs
Tests
createstubs: v1.5.1
TO-DO (provisional)
Upstream Documentation
Development:
Developing
Testing
API Reference
Indices and tables
¶
Index
Module Index
Search Page
Read the Docs
v: doc_updates
Versions
master
latest
v1.6.0
v1.4.1
main
doc_updates
develop
Downloads
On Read the Docs
Project Home
Builds