Skip to content

Commit c23697a

Browse files
authored
Use method colour key in the Builder API graph (#12998)
1 parent 5fa06f6 commit c23697a

File tree

2 files changed

+39
-6
lines changed

2 files changed

+39
-6
lines changed

doc/_static/diagrams/sphinx_build_flow.dot

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,54 @@ digraph build {
1313
shape=record
1414
label = "Sphinx | <init> __init__ | <build> build"
1515
];
16+
"legend" [
17+
shape=record
18+
label = <<table border="0" cellborder="0" cellspacing="0">
19+
<tr><td align="center"><u><b>Method types</b></u></td></tr>
20+
<tr><td align="left"><font color="darkorange">Final</font></td></tr>
21+
<tr><td align="left"><font color="darkblue">Overridable</font></td></tr>
22+
<tr><td align="left"><font color="darkgreen">Abstract</font></td></tr>
23+
</table>>
24+
];
25+
{rank=same; "Sphinx" "legend" };
26+
27+
"Builder.init" [color=darkblue];
28+
"Builder.build_all" [color=darkorange];
29+
"Builder.build_specific" [color=darkorange];
30+
"Builder.build_update" [color=darkorange];
31+
1632
"Sphinx":init -> "Builder.init";
1733
"Sphinx":build -> "Builder.build_all";
1834
"Sphinx":build -> "Builder.build_specific";
19-
"Builder.build_update" [
20-
shape=record
21-
label = "<p1> Builder.build_update | Builder.get_outdated_docs"
22-
];
23-
"Sphinx":build -> "Builder.build_update":p1 ;
35+
"Sphinx":build -> "Builder.build_update";
36+
37+
"Builder.get_outdated_docs" [color=darkgreen];
38+
"Builder.build_update" -> "Builder.get_outdated_docs";
39+
40+
"Builder.build" [color=darkorange];
2441

2542
"Builder.build_all" -> "Builder.build";
2643
"Builder.build_specific" -> "Builder.build";
2744
"Builder.build_update":p1 -> "Builder.build";
2845

46+
"Builder.read" [color=darkorange];
47+
"Builder.write" [color=darkorange];
48+
"Builder.finish" [color=darkblue];
49+
2950
"Builder.build" -> "Builder.read";
3051
"Builder.build" -> "Builder.write";
3152
"Builder.build" -> "Builder.finish";
3253

54+
"Builder.read_doc" [color=darkorange];
55+
"Builder.write_doctree" [color=darkorange];
56+
3357
"Builder.read" -> "Builder.read_doc";
3458
"Builder.read_doc" -> "Builder.write_doctree";
3559

60+
"Builder.prepare_writing" [color=darkblue];
61+
"Builder.copy_assets" [color=darkblue];
62+
"Builder.write_documents" [color=darkblue];
63+
3664
"Builder.write":p1 -> "Builder.prepare_writing";
3765
"Builder.write":p1 -> "Builder.copy_assets";
3866
"Builder.write_documents" [
@@ -41,8 +69,13 @@ digraph build {
4169
];
4270
"Builder.write":p1 -> "Builder.write_documents";
4371

72+
"Builder.write_doc" [color=darkgreen];
73+
"Builder.get_relative_uri" [color=darkblue];
74+
4475
"Builder.write_documents":p1 -> "Builder.write_doc";
4576
"Builder.write_doc" -> "Builder.get_relative_uri";
4677

78+
"Builder.get_target_uri" [color=darkgreen];
79+
4780
"Builder.get_relative_uri" -> "Builder.get_target_uri";
4881
}

doc/extdev/builderapi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Builder API
1212
It follows this basic workflow:
1313

1414
.. graphviz:: /_static/diagrams/sphinx_build_flow.dot
15-
:caption: UML for the standard Sphinx build workflow
15+
:caption: Call graph for the standard Sphinx build workflow
1616

1717
.. rubric:: Overridable Attributes
1818

0 commit comments

Comments
 (0)