papyri 0.0.8 Pypi GitHub

Parameters
ingest(paths: List[pathlib.Path], check: bool = False, relink: bool = True, dummy_progress: bool = <typer.models.OptionInfo object at 0x0000000>)

Parameters

paths : List of Path

list of paths (directories) to ingest. Maybe later we want to support zipped bundled but it's the not the case yet.

relink : bool

after ingesting all the path, should we rescan the whole library to find new crosslinks ?

check : bool

<Multiline Description Here>

dummy_progress : bool

<Multiline Description Here>

Given paths to a docbundle folder, ingest it into the known libraries.

Examples

See :

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/__init__.py#239
type: <class 'function'>
Commit: