mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
0e3f5b4ab2
Split the events callback API into a separate document, add a flow graph of the events within the build process, add parameters to the events, and link the `EnvironmentCollector` docs to the relevant events. Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
48 lines
1.3 KiB
Plaintext
48 lines
1.3 KiB
Plaintext
// UML for the standard Sphinx build workflow
|
|
|
|
digraph build {
|
|
graph [
|
|
rankdir=LR
|
|
];
|
|
node [
|
|
shape=rect
|
|
style=rounded
|
|
];
|
|
|
|
"Sphinx" [
|
|
shape=record
|
|
label = "Sphinx | <init> __init__ | <build> build"
|
|
];
|
|
"Sphinx":init -> "Builder.init";
|
|
"Sphinx":build -> "Builder.build_all";
|
|
"Sphinx":build -> "Builder.build_specific";
|
|
"Builder.build_update" [
|
|
shape=record
|
|
label = "<p1> Builder.build_update | Builder.get_outdated_docs"
|
|
];
|
|
"Sphinx":build -> "Builder.build_update":p1 ;
|
|
|
|
"Builder.build_all" -> "Builder.build";
|
|
"Builder.build_specific" -> "Builder.build";
|
|
"Builder.build_update":p1 -> "Builder.build";
|
|
|
|
"Builder.build" -> "Builder.read";
|
|
"Builder.write" [
|
|
shape=record
|
|
label = "<p1> Builder.write | Builder._write_serial | Builder._write_parallel"
|
|
];
|
|
"Builder.build" -> "Builder.write";
|
|
"Builder.build" -> "Builder.finish";
|
|
|
|
"Builder.read" -> "Builder.read_doc";
|
|
"Builder.read_doc" -> "Builder.write_doctree";
|
|
|
|
"Builder.write":p1 -> "Builder.prepare_writing";
|
|
"Builder.write":p1 -> "Builder.copy_assets";
|
|
"Builder.write":p1 -> "Builder.write_doc";
|
|
|
|
"Builder.write_doc" -> "Builder.get_relative_uri";
|
|
|
|
"Builder.get_relative_uri" -> "Builder.get_target_uri";
|
|
}
|