papyri 0.0.8 Pypi GitHub

ParametersReturnsBackRef
prepare_doc_for_one_object(self, target_item: 'Any', ndoc, *, qa: 'str', config: 'Config', aliases: 'List[str]', api_object) -> 'Tuple[DocBlob, List]'

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 : <Insert Type here>

<Multiline Description Here>

Returns

Tuple of two items,
ndoc:

DocBundle with info for current object.

figs:

dict mapping figure names to figure data.

Get documentation information for one python object

See Also

collect_api_docs

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

papyri.gen.Gen.collect_api_docs

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#1377
type: <class 'function'>
Commit: