stubber.publish.merge_docstubs

Merge firmware stubs and docstubs into a single folder

Module Contents

Functions

fw_folder_name(base, fw)

return the name of the firmware folder

merge_all_docstubs(versions[, family, mpy_path])

merge docstubs into firmware stubs

copy_docstubs(fw_path, dest_path, docstub_path)

param fw_path

Path to firmware stubs (absolute path)

Attributes

LAST_VERSION

stubber.publish.merge_docstubs.LAST_VERSION = v1.19.1
stubber.publish.merge_docstubs.fw_folder_name(base: str, fw: Dict)

return the name of the firmware folder

Parameters

  • base (str) –

  • fw (Dict) –

stubber.publish.merge_docstubs.merge_all_docstubs(versions, family: str = 'micropython', *, mpy_path=CONFIG.mpy_path)

merge docstubs into firmware stubs

Parameters

family (str) –

stubber.publish.merge_docstubs.copy_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