Skip to content

Commit 20b53bc

Browse files
authored
Add a graph illustrating the build phases to the docs (#13108)
1 parent 041326f commit 20b53bc

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

Diff for: doc/_static/diagrams/sphinx_build_phases.dot

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
digraph phases {
2+
3+
graph [
4+
rankdir = LR
5+
]
6+
7+
node [
8+
shape = rect;
9+
style = filled;
10+
fillcolor ="#f7f7f7";
11+
fontcolor = "#0a507a"
12+
]
13+
14+
Initialization -> Reading;
15+
Reading -> "Consistency checks";
16+
"Consistency checks" -> Resolving;
17+
Resolving -> Writing;
18+
}

Diff for: doc/extdev/index.rst

+3
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ Build phases
9595
One thing that is vital in order to understand extension mechanisms is the way
9696
in which a Sphinx project is built: this works in several phases.
9797

98+
.. graphviz:: /_static/diagrams/sphinx_build_phases.dot
99+
:caption: Build phases
100+
98101
**Phase 0: Initialization**
99102

100103
In this phase, almost nothing of interest to us happens. The source

0 commit comments

Comments
 (0)