stubber.publish.merge_docstubs
¶
Merge firmware stubs and docstubs into a single folder
Module Contents¶
Functions¶
|
merge docstubs and board stubs to merged stubs |
|
|
- stubber.publish.merge_docstubs.merge_all_docstubs(versions: List[str] | str | None = None, family: str = 'micropython', ports: List[str] | str | None = None, boards: List[str] | str | None = None, *, mpy_path: pathlib.Path = CONFIG.mpy_path)¶
merge docstubs and board stubs to merged stubs
- stubber.publish.merge_docstubs.copy_and_merge_docstubs(fw_path: pathlib.Path, dest_path: pathlib.Path, docstub_path: pathlib.Path)¶
- Parameters:
fw_path (pathlib.Path) – Path to firmware stubs (absolute path)
dest_path (pathlib.Path) – Path to destination (absolute path)
mpy_version – micropython version (‘1.18’)
docstub_path (pathlib.Path) –
Copy files from the firmware stub folders to the merged - 1 - Copy all firmware stubs to the package folder - 1.B - clean up a little bit - 2 - Enrich the firmware stubs with the document stubs