papyri
{ } Raw JSON

bundles / papyri latest / papyri / gen / Gen / collect_api_docs

function

papyri.gen:Gen.collect_api_docs

source: /papyri/gen.py :1802

Signature

def   collect_api_docs ( self ,  root : str ,  limit_to : list[str] )  →  None

Summary

Crawl one module and stores resulting DocBundle in json files.

Parameters

root : str

Module name to generate DocBundle for.

limit_to : list of string

For partial documentation building and testing purposes we may want to generate documentation for only a single item. If this list is non-empty we will collect documentation just for these items.

See also

prepare_doc_for_one_object

Aliases

  • papyri.gen.Gen.collect_api_docs