Created
April 13, 2023 18:16
-
-
Save seyyedaliayati/ea2af479c61c6551aac1ea6ea888a621 to your computer and use it in GitHub Desktop.
Enabling --include-call-diagrams flag in `aptos move` command.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
diff --git a/aptos-move/framework/src/aptos.rs b/aptos-move/framework/src/aptos.rs | |
index 845756d18f..bc43243adb 100644 | |
--- a/aptos-move/framework/src/aptos.rs | |
+++ b/aptos-move/framework/src/aptos.rs | |
@@ -110,6 +110,7 @@ impl ReleaseTarget { | |
include_impl: true, | |
include_specs: true, | |
specs_inlined: false, | |
+ include_call_diagrams: false, | |
include_dep_diagram: false, | |
collapsed_sections: true, | |
landing_page_template: Some("doc_template/overview.md".to_string()), | |
diff --git a/aptos-move/framework/src/docgen.rs b/aptos-move/framework/src/docgen.rs | |
index 68a9d925bd..534d926cff 100644 | |
--- a/aptos-move/framework/src/docgen.rs | |
+++ b/aptos-move/framework/src/docgen.rs | |
@@ -25,6 +25,10 @@ pub struct DocgenOptions { | |
#[clap(long)] | |
pub specs_inlined: bool, | |
+ /// Whether to include call diagrams in the generated docs. Defaults to false. | |
+ #[clap(long)] | |
+ pub include_call_diagrams: bool, | |
+ | |
/// Whether to include a dependency diagram. Defaults to false. | |
#[clap(long)] | |
pub include_dep_diagram: bool, | |
@@ -92,7 +96,7 @@ impl DocgenOptions { | |
.unwrap_or_else(Vec::new), | |
references_file: self.references_file.clone(), | |
include_dep_diagrams: self.include_dep_diagram, | |
- include_call_diagrams: false, | |
+ include_call_diagrams: self.include_call_diagrams, | |
compile_relative_to_output_dir: false, | |
}; | |
let output = move_docgen::Docgen::new(model, &options).gen(); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment