Skip to content

Commit

Permalink
Don't fail documentation without the default feature (#5180)
Browse files Browse the repository at this point in the history
This commit fixes `cargo doc -p wasmtime --no-default-features` where
previously it would fail with many broken doc links because the crate is
missing many items that links refer to. Instead they're emitted as
warnings now which while noisy should prevent the build from being
entirely usable at least.
  • Loading branch information
alexcrichton authored Nov 2, 2022
1 parent 2afaac5 commit e0c8a7f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions crates/wasmtime/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -379,12 +379,16 @@
//! # }
//! ```
#![allow(unknown_lints)]
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
#![deny(missing_docs)]
#![doc(test(attr(deny(warnings))))]
#![doc(test(attr(allow(dead_code, unused_variables, unused_mut))))]
#![cfg_attr(nightlydoc, feature(doc_cfg))]
#![cfg_attr(not(feature = "default"), allow(dead_code, unused_imports))]
// Allow broken links when the default features is disabled because most of our
// documentation is written for the "one build" of the `main` branch which has
// most features enabled. This will present warnings in stripped-down doc builds
// and will prevent the doc build from failing.
#![cfg_attr(feature = "default", deny(rustdoc::broken_intra_doc_links))]

#[macro_use]
mod func;
Expand Down

0 comments on commit e0c8a7f

Please sign in to comment.