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:
Alex Crichton
2020-01-07 14:42:35 -06:00
committed by GitHub
parent 41528c82bc
commit d142a39113
5 changed files with 14 additions and 11 deletions

View File

@@ -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,
}