Tweak some API doc generation (#772)
* Build docs with the nightly toolchain so [foo::bar] links work by default. This is a relatively new feature of rustdoc and I thought it was stabilized at this point but apparently it's not! * Tweak some API docs on `wasmtime::Strategy` * Use `--all` to build all local crate documentation instead of trying to list the number of local crates * Tweak some documentation configuration to avoid warnings generated by Cargo.
This commit is contained in:
14
.github/workflows/main.yml
vendored
14
.github/workflows/main.yml
vendored
@@ -46,17 +46,9 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
submodules: true
|
submodules: true
|
||||||
- uses: ./.github/actions/install-rust
|
- uses: ./.github/actions/install-rust
|
||||||
- run: cargo doc --no-deps -p wasmtime-cli
|
with:
|
||||||
- run: cargo doc --no-deps -p wasmtime
|
toolchain: nightly
|
||||||
- run: cargo doc --no-deps -p wasmtime-debug
|
- run: cargo doc --no-deps --all --exclude wasmtime-cli --exclude test-programs
|
||||||
- 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
|
|
||||||
- uses: actions/upload-artifact@v1
|
- uses: actions/upload-artifact@v1
|
||||||
with:
|
with:
|
||||||
name: doc-api
|
name: doc-api
|
||||||
|
|||||||
@@ -229,6 +229,8 @@ impl Default for Config {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Possible Compilation strategies for a wasm module.
|
/// Possible Compilation strategies for a wasm module.
|
||||||
|
///
|
||||||
|
/// This is used as an argument to the [`Config::strategy`] method.
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
#[derive(Clone, Debug)]
|
#[derive(Clone, Debug)]
|
||||||
pub enum Strategy {
|
pub enum Strategy {
|
||||||
@@ -249,6 +251,9 @@ pub enum Strategy {
|
|||||||
|
|
||||||
/// A single-pass code generator that is faster than Cranelift but doesn't
|
/// A single-pass code generator that is faster than Cranelift but doesn't
|
||||||
/// produce as high-quality code.
|
/// produce as high-quality code.
|
||||||
|
///
|
||||||
|
/// To successfully pass this argument to [`Config::strategy`] the
|
||||||
|
/// `lightbeam` feature of this crate must be enabled.
|
||||||
Lightbeam,
|
Lightbeam,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ edition = "2018"
|
|||||||
name = "_wasmtime"
|
name = "_wasmtime"
|
||||||
crate-type = ["cdylib"]
|
crate-type = ["cdylib"]
|
||||||
test = false
|
test = false
|
||||||
|
doc = false
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
wasmtime = { path = "../../api" }
|
wasmtime = { path = "../../api" }
|
||||||
|
|||||||
@@ -32,3 +32,4 @@ maintenance = { status = "actively-developed" }
|
|||||||
[lib]
|
[lib]
|
||||||
test = false
|
test = false
|
||||||
doctest = false
|
doctest = false
|
||||||
|
doc = false
|
||||||
|
|||||||
@@ -21,18 +21,22 @@ libfuzzer-sys = { git = "https://github.com/rust-fuzz/libfuzzer-sys.git" }
|
|||||||
name = "compile"
|
name = "compile"
|
||||||
path = "fuzz_targets/compile.rs"
|
path = "fuzz_targets/compile.rs"
|
||||||
test = false
|
test = false
|
||||||
|
doc = false
|
||||||
|
|
||||||
[[bin]]
|
[[bin]]
|
||||||
name = "instantiate"
|
name = "instantiate"
|
||||||
path = "fuzz_targets/instantiate.rs"
|
path = "fuzz_targets/instantiate.rs"
|
||||||
test = false
|
test = false
|
||||||
|
doc = false
|
||||||
|
|
||||||
[[bin]]
|
[[bin]]
|
||||||
name = "instantiate_translated"
|
name = "instantiate_translated"
|
||||||
path = "fuzz_targets/instantiate_translated.rs"
|
path = "fuzz_targets/instantiate_translated.rs"
|
||||||
test = false
|
test = false
|
||||||
|
doc = false
|
||||||
|
|
||||||
[[bin]]
|
[[bin]]
|
||||||
name = "api_calls"
|
name = "api_calls"
|
||||||
path = "fuzz_targets/api_calls.rs"
|
path = "fuzz_targets/api_calls.rs"
|
||||||
test = false
|
test = false
|
||||||
|
doc = false
|
||||||
|
|||||||
Reference in New Issue
Block a user