From ea46ed831e86cdc7ca3e2a243daa3d3e7c6c1b2a Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Wed, 6 Nov 2024 14:16:45 +0100 Subject: [PATCH] Add a graph illustrating the build phases to the docs Visual representations of processes ease the understanding. --- doc/_static/diagrams/sphinx_build_phases.dot | 18 ++++++++++++++++++ doc/extdev/index.rst | 3 +++ 2 files changed, 21 insertions(+) create mode 100644 doc/_static/diagrams/sphinx_build_phases.dot diff --git a/doc/_static/diagrams/sphinx_build_phases.dot b/doc/_static/diagrams/sphinx_build_phases.dot new file mode 100644 index 00000000000..2d566df066f --- /dev/null +++ b/doc/_static/diagrams/sphinx_build_phases.dot @@ -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; +} diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 5160cd45e72..17618992726 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -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