stubber.commands.get_docstubs_cmd

get-docstubs

Functions

cli_docstubs(ctx[, path, target, format, autoflake, ...])

Build stubs from documentation.

Module Contents

stubber.commands.get_docstubs_cmd.cli_docstubs(ctx: rich_click.Context, path: str | None = None, target: str | None = None, format: bool = True, autoflake: bool = True, clean_rst: bool = True, basename: str | None = None, version: str = '', enrich: bool = False)

Build stubs from documentation.

Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking.

Parameters:
  • ctx (rich_click.Context)

  • path (Optional[str])

  • target (Optional[str])

  • format (bool)

  • autoflake (bool)

  • clean_rst (bool)

  • basename (Optional[str])

  • version (str)

  • enrich (bool)