How to test a package.metadata.docs.rs setting?

help
#1

Hi,

I've used #![cfg_attr(docsrs, feature(doc_cfg))] and #[cfg_attr(docsrs, doc(cfg(feature = "my_flag")))] like Tokio does.

Added in Cargo.toml :

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

Now I'm wondering how do I test that locally before pushing everything on crates.io?

Thanks!

#2

You can pass the cfg directly while building docs using cargo by setting the environment variable RUSTFLAGS="--cfg docsrs"

1 Like
#3

I had to use RUSTDOCFLAGS but that was the solution :slight_smile: thanks!

1 Like
#4

TIL RUSTDOCFLAGS exists

1 Like
#5

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.