Skip to content

Commit

Permalink
[move] Enable documentation generation (aptos-labs#5187)
Browse files Browse the repository at this point in the history
This PR enables the Move documentation generator. The generator is available via the cli (`aptos move document`). It's also integrated into the framework framework building process and will be automatically triggered similar as other derived artifacts, via `cached-packages` or explicit release building.

The generated documentation is reachable via github, here is an [example created by this PR]().
  • Loading branch information
wrwg authored Oct 21, 2022
1 parent 2d3a7ab commit 07e38a0
Show file tree
Hide file tree
Showing 95 changed files with 45,097 additions and 63 deletions.
2 changes: 2 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions aptos-move/e2e-move-tests/src/tests/scripts.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ fn test_two_to_two_transfer() {
with_abis: false,
with_source_maps: false,
with_error_map: false,
install_dir: None,
named_addresses: Default::default(),
..framework::BuildOptions::default()
};

let package = framework::BuiltPackage::build(
Expand Down
19 changes: 10 additions & 9 deletions aptos-move/framework/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,25 @@ publish = false

[dependencies]
anyhow = "1.0.57"
aptos-aggregator = { path = "../../aptos-move/aptos-aggregator" }
aptos-crypto = { path = "../../crates/aptos-crypto" }
aptos-module-verifier = { path = "../../aptos-move/aptos-module-verifier" }
aptos-sdk-builder = { path = "../aptos-sdk-builder" }
aptos-state-view = { path = "../../storage/state-view" }
aptos-types = { path = "../../types" }
base64 = "0.13.0"
bcs = { git = "https://github.com/aptos-labs/bcs", rev = "2cde3e8446c460cb17b0c1d6bac7e27e964ac169" }
better_any = "0.1.1"
clap = "3.1.8"
codespan-reporting = "0.11.1"
curve25519-dalek = { version = "3", default-features = false }
flate2 = "1.0.24"
gas-algebra-ext = { path = "../gas-algebra-ext" }
include_dir = "0.7.2"
itertools = "0.10.0"
libsecp256k1 = "0.7.0"
log = "0.4.17"
move-binary-format = { workspace = true }
once_cell = "1.10.0"
proptest = { version = "1.0.0", optional = true }
proptest-derive = { version = "0.3.0", optional = true }
Expand All @@ -35,18 +44,10 @@ smallvec = "1.8.0"
tempfile = "3.3.0"
tiny-keccak = { version = "2.0.2", features = ["keccak"] }

aptos-aggregator = { path = "../../aptos-move/aptos-aggregator" }
aptos-crypto = { path = "../../crates/aptos-crypto" }
aptos-module-verifier = { path = "../../aptos-move/aptos-module-verifier" }
aptos-sdk-builder = { path = "../aptos-sdk-builder" }
aptos-state-view = { path = "../../storage/state-view" }
aptos-types = { path = "../../types" }
gas-algebra-ext = { path = "../gas-algebra-ext" }
move-binary-format = { workspace = true }

move-command-line-common = { workspace = true }
move-compiler ={ workspace = true }
move-core-types ={ workspace = true }
move-docgen ={ workspace = true }
move-model ={ workspace = true }
move-package ={ workspace = true }
move-table-extension ={ workspace = true }
Expand Down
Loading

0 comments on commit 07e38a0

Please sign in to comment.