Skip to content

Commit

Permalink
Add a graph illustrating the build phases to the docs
Browse files Browse the repository at this point in the history
Visual representations of processes ease the understanding.
  • Loading branch information
timhoffm committed Nov 6, 2024
1 parent d374a1c commit ea46ed8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/_static/diagrams/sphinx_build_phases.dot
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
digraph phases {

graph [
rankdir = LR
]

node [
shape = rect;
style = filled;
fillcolor ="#f7f7f7";
fontcolor = "#0a507a"
]

Initialization -> Reading;
Reading -> "Consistency checks";
"Consistency checks" -> Resolving;
Resolving -> Writing;
}
3 changes: 3 additions & 0 deletions doc/extdev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ Build phases
One thing that is vital in order to understand extension mechanisms is the way
in which a Sphinx project is built: this works in several phases.

.. graphviz:: /_static/diagrams/sphinx_build_phases.dot
:caption: Build phases

**Phase 0: Initialization**

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

0 comments on commit ea46ed8

Please sign in to comment.