papyri 0.0.8 Pypi GitHub


ParametersReturnsBackRef
Gen.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
ndoc :
qa : str
config : Config
aliases : sequence
api_object : <Insert Type here>

Returns

Tuple of two items,
ndoc:
figs:

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 : /work/papyri/papyri/papyri/gen.py#1457
type: <class 'function'>
Commit: