Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use method colour key in the Builder API graph #12998

Merged
merged 7 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions doc/_static/diagrams/sphinx_build_flow.dot
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,52 @@ digraph build {
shape=rect
style=rounded
];
// note: outline color of node indicates method type:
// darkgreen = abstract
// orange = overridable
// red = final

"Sphinx" [
shape=record
label = "Sphinx | <init> __init__ | <build> build"
];
"Builder.init" [color=orange];
"Builder.build_all" [color=red];
"Builder.build_specific" [color=red];
"Builder.build_update" [color=red];

"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 ;
"Sphinx":build -> "Builder.build_update";

"Builder.get_outdated_docs" [color=darkgreen];
"Builder.build_update" -> "Builder.get_outdated_docs";

"Builder.build" [color=red];

"Builder.build_all" -> "Builder.build";
"Builder.build_specific" -> "Builder.build";
"Builder.build_update":p1 -> "Builder.build";

"Builder.read" [color=red];
"Builder.write" [color=red];
"Builder.finish" [color=orange];

"Builder.build" -> "Builder.read";
"Builder.build" -> "Builder.write";
"Builder.build" -> "Builder.finish";

"Builder.read_doc" [color=red];
"Builder.write_doctree" [color=red];

"Builder.read" -> "Builder.read_doc";
"Builder.read_doc" -> "Builder.write_doctree";

"Builder.prepare_writing" [color=orange];
"Builder.copy_assets" [color=orange];
"Builder.write_documents" [color=orange];

"Builder.write":p1 -> "Builder.prepare_writing";
"Builder.write":p1 -> "Builder.copy_assets";
"Builder.write_documents" [
Expand All @@ -41,8 +62,13 @@ digraph build {
];
"Builder.write":p1 -> "Builder.write_documents";

"Builder.write_doc" [color=darkgreen];
"Builder.get_relative_uri" [color=orange];

"Builder.write_documents":p1 -> "Builder.write_doc";
"Builder.write_doc" -> "Builder.get_relative_uri";

"Builder.get_target_uri" [color=darkgreen];

"Builder.get_relative_uri" -> "Builder.get_target_uri";
}
1 change: 1 addition & 0 deletions doc/extdev/builderapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Builder API

.. graphviz:: /_static/diagrams/sphinx_build_flow.dot
:caption: UML for the standard Sphinx build workflow
chrisjsewell marked this conversation as resolved.
Show resolved Hide resolved
(method colors: green; abstract, orange; overridable, red; final)
chrisjsewell marked this conversation as resolved.
Show resolved Hide resolved

.. rubric:: Overridable Attributes

Expand Down