papyri 0.0.8 Pypi GitHub

ParametersReturns
gen_main(infer: 'Optional[bool]', exec_: 'Optional[bool]', target_file: 'str', debug, *, dummy_progress: 'bool', dry_run=<class 'bool'>, api: 'bool', examples: 'bool', fail, narrative, fail_early: 'bool', fail_unseen_error: 'bool') -> 'None'

This will take care of reading single configuration file with the option 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

None

Main entry point to generate docbundle files,

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /papyri/gen.py#443
type: <class 'function'>
Commit: