stubber.publish.merge_docstubs
==============================

.. py:module:: stubber.publish.merge_docstubs

.. autoapi-nested-parse::

   Merge firmware stubs and docstubs into a single folder.



Functions
---------

.. autoapisummary::

   stubber.publish.merge_docstubs.merge_all_docstubs
   stubber.publish.merge_docstubs.copy_and_merge_docstubs
   stubber.publish.merge_docstubs.refactor_rp2_module
   stubber.publish.merge_docstubs.patch_rp2_init_pyi


Module Contents
---------------

.. py:function:: merge_all_docstubs(versions: Optional[Union[List[str], str]] = None, family: str = 'micropython', ports: Optional[Union[List[str], str]] = None, boards: Optional[Union[List[str], str]] = None, clean: bool = True)

   Merge docstubs and firmware stubs into merged stubs.


.. py:function:: copy_and_merge_docstubs(fw_path: pathlib.Path, dest_path: pathlib.Path, docstub_path: pathlib.Path, clean: bool = True)

   :param fw_path: Path to the source firmware stubs (absolute path)
   :param dest_path: Path to destination (absolute path)
   :param docstub_path: Path to docstubs

   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



.. py:function:: refactor_rp2_module(dest_path: pathlib.Path)

   refactor the rp2 module to allow for submodules


.. py:function:: patch_rp2_init_pyi(rp2_init_file: pathlib.Path) -> None

   Normalize generated rp2/__init__.pyi typing surface:
   - suppress `_PIO_ASM_Program: TypeAlias = Callable`
   - keep `PIOASMEmit` opaque (only __init__ + __getattr__)
   - make `_PIO_ASM_Program` an opaque class without `__getitem__`