stubber.stubs_from_docs
=======================

.. py:module:: stubber.stubs_from_docs

.. autoapi-nested-parse::

   Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking
   using a custom-built parser to read and process the micropython RST files



Functions
---------

.. autoapisummary::

   stubber.stubs_from_docs.generate_from_rst
   stubber.stubs_from_docs.clean_destination
   stubber.stubs_from_docs.get_rst_sources
   stubber.stubs_from_docs.make_docstubs
   stubber.stubs_from_docs.make_docstub


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

.. py:function:: generate_from_rst(rst_path: pathlib.Path, dst_path: pathlib.Path, v_tag: str, release: Optional[str] = None, pattern: str = '*.rst', suffix: str = '.pyi', format: bool = True, autoflake: bool = True, clean_rst: bool = True) -> int

.. py:function:: clean_destination(dst_path: pathlib.Path)

   Remove all .py/.pyi files in desination folder to avoid left-behinds


.. py:function:: get_rst_sources(rst_path: pathlib.Path, pattern: str) -> List[pathlib.Path]

   Get the list of rst files to process


.. py:function:: make_docstubs(dst_path: pathlib.Path, v_tag: str, release: str, suffix: str, files: List[pathlib.Path], clean_rst: bool)

   Create docstubs from the list of rst files


.. py:function:: make_docstub(file: pathlib.Path, dst_path: pathlib.Path, v_tag: str, release: str, suffix: str, clean_rst: bool)

   Create a docstub from a single rst file