We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
See: https://docs.rs/crate/bdk/1.0.0-alpha.0
can we somehow make sure in CI that the docs will build on docs.rs before merging?
The text was updated successfully, but these errors were encountered:
The nightly docs we build in CI are working: https://bitcoindevkit.org/docs-rs/bdk/nightly/latest/bdk/
To troubleshoot why docs.rs docs aren't working we'll need to go through local testing with the docs.rs docker container environment, see: https://github.com/rust-lang/docs.rs/blob/master/README.md
Sorry, something went wrong.
Adding some notes as I go along incase we run into this issue again.
cd crates/bdk cargo +nightly rustdoc --lib -Zrustdoc-map --all-features -Z unstable-options --config build.rustdocflags='["--cfg", "docsrs", "-Z", "unstable-options", "--emit=invocation-specific", "--resource-suffix", "-20230319-1.70.0-nightly-da7c50c08", "--static-root-path", "/-/rustdoc.static/", "--cap-lints", "warn", "--disable-per-crate-search", "--extern-html-root-takes-precedence"]' -Zunstable-options -Zrustdoc-scrape-examples -j3
The problem is we need to enable the doc_cfg feature when the docsrs configuration attribute is defined:
doc_cfg
docsrs
#![cfg_attr(docsrs, feature(doc_cfg))]
Fix in #1011
notmandatory
Successfully merging a pull request may close this issue.
See: https://docs.rs/crate/bdk/1.0.0-alpha.0
can we somehow make sure in CI that the docs will build on docs.rs before merging?
The text was updated successfully, but these errors were encountered: