bundles / papyri 0.0.10 / papyri / gen / Gen / prepare_doc_for_one_object

function

`papyri.gen:Gen.prepare_doc_for_one_object`

source: /papyri/gen.py:1406

Signature

def prepare_doc_for_one_object(self, target_item: Any, ndoc: Any, *, qa: str, config: Config, aliases: list[str], api_object: APIObjectInfo) → tuple[GeneratedDoc, list[Any]]

Summary

Get documentation information for one python object

Parameters

target_item : any: the object you want to get documentation for
ndoc: numpydoc parsed docstring.
qa : str: fully qualified object path.
config : Config: current configuratin
aliases : sequence: other aliases for cuttent object.
api_object : APIObjectInfo: Describes the object's type and other relevant information

Returns

: Tuple of two items,
: blob:: GeneratedDoc with info for current object.
: figs:: dict mapping figure names to figure data.

See also

collect_api_docs

Aliases

papyri.gen.Gen.prepare_doc_for_one_object