docs: fix build with unstable features#849
Merged
yara-blue merged 1 commit intoRustAudio:masterfrom Feb 22, 2026
Merged
Conversation
Member
|
O.o. 💥 |
Member
|
oh and thanks so much for not only reporting but coming up with a fix! 🎉 Especially with something as time sensitive as this 😅 |
Contributor
Author
|
No problem! Here's a follow-up PR to verify docs in CI: #850 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs failed to build for 0.22.0 because
#[doc(cfg)]is experimental (see build logs here).We can fix this by passing
cargo-args = ["-Zunstable-options"]Additionally, we can use
#![cfg_attr(docsrs, feature(doc_cfg))]to automatically document features without having to add#[cfg_attr(docsrs, doc(cfg(feature = "feature_name")))]everywhere.We can verify this works by running
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc -Zunstable-options --all-features --no-deps --openand checking the output: