`papyri.gen:gen_main`

source: /papyri/gen.py :231

Signature

   def     gen_main (    infer  :  bool | None    ,    exec_  :  bool | None    ,    target_file  :  str    ,    debug  :  bool    ,  * ,     dummy_progress  :  bool    ,    dry_run  :  bool    ,    api  :  bool    ,    examples  :  bool    ,    fail  :  bool    ,    narrative  :  bool    ,    fail_early  :  bool    ,    fail_unseen_error  :  bool    ,    limit_to  :  list[str]      )   →  Path | None

Summary

Main entry point to generate DocBundle files.

Extended Summary

This will take care of reading single configuration files with the options for the library you want to build the docs for, scrape API, narrative and examples, and put it into a doc bundle for later consumption.

Parameters

infer : bool | None: CLI override of whether to run type inference on examples
exec_ : bool | None: CLI override of whether to execute examples/code blocks
target_file : str: Patch of configuration file
dummy_progress : bool: CLI flag to disable progress that might screw up with ipdb formatting when debugging.
api : bool: CLI override of whether to build api docs
examples : bool: CLI override of whether to build examples docs
fail: TBD
narrative : bool: CLI override of whether to build narrative docs
dry_run : bool: don't write to disk
debug : bool: set log level to debug
fail_early : bool: overwrite early_error option in config file
fail_unseen_error : bool: raise an exception if the error is unseen

Returns

: Path | None: Path to the generated DocBundle directory, or None if dry_run is True.

Aliases

papyri.gen.gen_main