Show proper cfgs on documentation

daxpedda · Dec 24, 2023 · 821a55d · 821a55d
1 parent 84d07ea
commit 821a55d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -36,7 +36,7 @@ jobs:
  rustup default nightly
  - name: Run Rustdoc
  env:
- RUSTDOCFLAGS: --crate-version main
+ RUSTDOCFLAGS: --crate-version main --cfg=docsrs
  run: cargo doc --no-deps -Z rustdoc-map -Z rustdoc-scrape-examples --target wasm32-unknown-unknown
  - name: Setup Pages
  uses: actions/configure-pages@v4

diff --git a/Cargo.toml b/Cargo.toml
@@ -48,6 +48,7 @@ name = "benchmark"
 path = "benches/benchmark.rs"
 
 [package.metadata.docs.rs]
+rustdoc-args = ["--cfg=docsrs"]
 targets = ["wasm32-unknown-unknown"]
 
 [lints.rust]

diff --git a/src/lib.rs b/src/lib.rs
@@ -107,6 +107,8 @@
 //! [`Performance.timeOrigin`]: https://developer.mozilla.org/en-US/docs/Web/API/Performance/timeOrigin
 //! [`wasm-bindgen`]: https://crates.io/crates/wasm-bindgen
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 #[cfg(all(
  target_family = "wasm",
  not(any(target_os = "emscripten", target_os = "wasi"))
@@ -119,6 +121,7 @@ mod time;
  ),
  docsrs
 ))]
+#[cfg_attr(docsrs, doc(cfg(Web)))]
 pub mod web;
 
 #[cfg(not(all(