Skip to content

Commit 385e84d

Browse files
committed
doc(api): upd module-deps diagram
1 parent 95345c8 commit 385e84d

File tree

3 files changed

+219
-180
lines changed

3 files changed

+219
-180
lines changed

docs/GraphtikModuleDependencies.dot

Lines changed: 51 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,47 +6,66 @@ digraph {
66
label="graphtik-v8.1+ module dependencies";
77
labelloc=t;
88
node [style=filled];
9+
nodesep=0.55;
10+
remincross=true;
911

10-
subgraph cluster_core {
11-
label="core modules";
12-
tooltip="most modules depend on them";
12+
"plot.py" [shape=component
13+
tooltip="(extra)"
14+
fillcolor=Aquamarine
15+
URL="reference.html#module-graphtik.plot"];
16+
"sphinxext/" [shape=component
17+
tooltip="(extra)"
18+
fillcolor=Aquamarine
19+
URL="reference.html#module-graphtik.sphinxext"];
20+
21+
subgraph cluster_base {
22+
label="base";
23+
labelloc=b;
24+
tooltip="almost all other modules depend on these";
25+
26+
"config.py" [shape=component tooltip="(public) almost everything import this module"
27+
fillcolor=wheat
28+
URL="reference.html#module-graphtik.config"];
1329
"base.py" [shape=component
1430
tooltip="(implicit) everything imports this module, not shown"
15-
fillcolor=AliceBlue
31+
fillcolor=wheat
1632
URL="reference.html#module-graphtik.base"];
17-
"config.py" [shape=component tooltip="(public)"
33+
"modifiers.py" [shape=component
34+
tooltip="(public) almost everything imports this module"
1835
fillcolor=wheat
19-
URL="reference.html#module-graphtik.config"];
36+
URL="reference.html#module-graphtik.modifiers"];
2037
}
21-
"modifiers.py" [shape=component
22-
tooltip="(public) almost everything imports this module"
38+
39+
"pipeline.py" [shape=component
40+
tooltip="(public)"
2341
fillcolor=wheat
24-
URL="reference.html#module-graphtik.modifiers"];
25-
"composition.py" [shape=component
42+
URL="reference.html#module-graphtik.pipeline"];
43+
"op.py" [shape=component
2644
tooltip="(public)"
2745
fillcolor=wheat
28-
URL="reference.html#module-graphtik.composition"];
29-
"network.py" [shape=component
30-
tooltip="(private)"
31-
fillcolor=AliceBlue
32-
URL="reference.html#module-graphtik.network"];
33-
"execution.py" [shape=component
34-
tooltip="(private)"
35-
fillcolor=AliceBlue
36-
URL="reference.html#module-graphtik.execution"];
37-
"plot.py" [shape=component
38-
tooltip="(extra)"
39-
fillcolor=Aquamarine
40-
URL="reference.html#module-graphtik.plot"];
41-
"sphinxext/" [shape=component
42-
tooltip="(extra)"
43-
fillcolor=Aquamarine
44-
URL="reference.html#module-graphtik.sphinxext"];
46+
URL="reference.html#module-graphtik.op"];
47+
48+
subgraph cluster_network {
49+
label="core modules";
50+
tooltip="related to graph solution";
51+
URL="arch.html#term-execution";
52+
53+
"execution.py" [shape=component
54+
tooltip="(private)"
55+
fillcolor=AliceBlue
56+
URL="reference.html#module-graphtik.execution"];
57+
"network.py" [shape=component
58+
tooltip="(private)"
59+
fillcolor=AliceBlue
60+
URL="reference.html#module-graphtik.network"];
61+
}
4562

46-
{"composition.py", "network.py", "execution.py", "plot.py"} -> "modifiers.py" [tooltip="(import-time)"];
47-
{"network.py", "execution.py", "plot.py", "sphinxext/"} -> "composition.py" [tooltip="(import-time)"];
63+
{"op.py", "pipeline.py", "network.py", "execution.py", "plot.py"} -> "base.py" [tooltip="(import-time)"];
64+
"base.py" -> "plot.py" [tooltip="(run-time)" style=dashed];
4865
"execution.py" -> "network.py" [tooltip="(import-time)"];
49-
"network.py" -> "execution.py" [tooltip="(run-time)" style=dashed];
50-
"composition.py" -> {"network.py", "execution.py", "plot.py"} [tooltip="(run-time)" style=dashed];
51-
"sphinxext/" -> "plot.py" [tooltip="(import-time)"];
66+
"network.py" -> {"op.py", "pipeline.py", "execution.py"} [tooltip="(run-time)" style=dashed];
67+
"op.py" -> "pipeline.py" [style=dashed
68+
tooltip="(run-time) for plotting"];
69+
"pipeline.py" -> {"op.py", "network.py"} [tooltip="(run-time)" style=dashed];
70+
"sphinxext/" -> "plot.py" [tooltip="(import-time)"];
5271
}

0 commit comments

Comments
 (0)