papyri 0.0.8 Pypi GitHub

ParametersBackRef
collect_api_docs(self, root: 'str')

Parameters

root : str

module name to generate docbundle for.

Crawl one module and stores resulting docbundle in self.store.

See Also

prepare_doc_for_one_object

Examples

See :

Back References

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

papyri.gen.Gen.prepare_doc_for_one_object

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