`papyri.cli.gen:gen`

source: /papyri/cli/gen.py :16

Signature

   def     gen (    file  :  Annotated[str, typer.Argument(help='toml configuration file', autocompletion=_find_toml)]    ,    infer  :  bool | None    =  <typer.models.OptionInfo object at 0x0000>   ,    exec  :  bool | None    =  <typer.models.OptionInfo object at 0x0000>   ,    debug  :  bool    =  False   ,    no_progress  :  bool    =  <typer.models.OptionInfo object at 0x0000>   ,    dry_run  :  bool    =  False   ,    api  :  bool    =  True   ,    examples  :  bool    =  True   ,    narrative  :  bool    =  True   ,    fail  :  bool    =  <typer.models.OptionInfo object at 0x0000>   ,    fail_early  :  bool    =  <typer.models.OptionInfo object at 0x0000>   ,    fail_unseen_error  :  bool    =  <typer.models.OptionInfo object at 0x0000>   ,    only  :  list[str]    =  <typer.models.OptionInfo object at 0x0000>   ,    upload  :  bool    =  <typer.models.OptionInfo object at 0x0000>   ,    pack  :  bool    =  <typer.models.OptionInfo object at 0x0000>     )   →  None

Summary

Generate documentation IR for a given package.

Extended Summary

First item should be the root package to import; if subpackages need to be analyzed but are not accessible from the root pass them as extra arguments.

This takes a single file and builds the IR for a single package. Building for multiple packages may have side effects (for example importing seaborn changes matplotlib defaults).

Aliases

papyri.cli.gen.gen