diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 859162128e..8ac002a4cd 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -46,17 +46,9 @@ jobs: with: submodules: true - uses: ./.github/actions/install-rust - - run: cargo doc --no-deps -p wasmtime-cli - - run: cargo doc --no-deps -p wasmtime - - run: cargo doc --no-deps -p wasmtime-debug - - run: cargo doc --no-deps -p wasmtime-environ - - run: cargo doc --no-deps -p wasmtime-interface-types - - run: cargo doc --no-deps -p wasmtime-jit - - run: cargo doc --no-deps -p wasmtime-obj - - run: cargo doc --no-deps -p wasmtime-runtime - - run: cargo doc --no-deps -p wasmtime-wasi - - run: cargo doc --no-deps -p wasmtime-wast - - run: cargo doc --no-deps -p wasi-common + with: + toolchain: nightly + - run: cargo doc --no-deps --all --exclude wasmtime-cli --exclude test-programs - uses: actions/upload-artifact@v1 with: name: doc-api diff --git a/crates/api/src/runtime.rs b/crates/api/src/runtime.rs index c7b5d87de2..500b9afbfa 100644 --- a/crates/api/src/runtime.rs +++ b/crates/api/src/runtime.rs @@ -229,6 +229,8 @@ impl Default for Config { } /// Possible Compilation strategies for a wasm module. +/// +/// This is used as an argument to the [`Config::strategy`] method. #[non_exhaustive] #[derive(Clone, Debug)] pub enum Strategy { @@ -249,6 +251,9 @@ pub enum Strategy { /// A single-pass code generator that is faster than Cranelift but doesn't /// produce as high-quality code. + /// + /// To successfully pass this argument to [`Config::strategy`] the + /// `lightbeam` feature of this crate must be enabled. Lightbeam, } diff --git a/crates/misc/py/Cargo.toml b/crates/misc/py/Cargo.toml index adfe6a61d2..1afe676b75 100644 --- a/crates/misc/py/Cargo.toml +++ b/crates/misc/py/Cargo.toml @@ -14,6 +14,7 @@ edition = "2018" name = "_wasmtime" crate-type = ["cdylib"] test = false +doc = false [dependencies] wasmtime = { path = "../../api" } diff --git a/crates/wasi-c/Cargo.toml b/crates/wasi-c/Cargo.toml index b11af77607..6104753440 100644 --- a/crates/wasi-c/Cargo.toml +++ b/crates/wasi-c/Cargo.toml @@ -32,3 +32,4 @@ maintenance = { status = "actively-developed" } [lib] test = false doctest = false +doc = false diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml index 768cb84eca..a1d2e97545 100644 --- a/fuzz/Cargo.toml +++ b/fuzz/Cargo.toml @@ -21,18 +21,22 @@ libfuzzer-sys = { git = "https://github.com/rust-fuzz/libfuzzer-sys.git" } name = "compile" path = "fuzz_targets/compile.rs" test = false +doc = false [[bin]] name = "instantiate" path = "fuzz_targets/instantiate.rs" test = false +doc = false [[bin]] name = "instantiate_translated" path = "fuzz_targets/instantiate_translated.rs" test = false +doc = false [[bin]] name = "api_calls" path = "fuzz_targets/api_calls.rs" test = false +doc = false