1 unstable release
0.1.0 | Nov 23, 2022 |
---|
#40 in #facilitate
142 downloads per month
Used in 9 crates
(8 directly)
3KB
Crate thet facilitates the documentation of feature-gated code. This crate requires the use of the doc_cfg
nightly feature.
Remember to add the following to your Cargo.toml
file for the crate make efect when documenting on docs.rs
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
And when generating local documentation, use
cargo rustdoc -- --cfg docsrs
Example
#[docfg(test)]
fn test () {
// ...
}
#[cfg_attr(docsrs, doc(cfg(test)))]
#[cfg(test)]
fn test () {
// ...
}
Dependencies
~1.5MB
~35K SLoC