Fix docs for tokio feature

Author: DanglingPointer

.github/workflows/ci.yml

@@ -62,9 +62,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: dtolnay/rust-toolchain@stable
+    - uses: dtolnay/rust-toolchain@nightly
     - run: cargo test --doc
     - run: cargo doc --lib --no-deps --all-features --document-private-items
       env:
-        RUSTDOCFLAGS: -Dwarnings
-        RUSTFLAGS: -Dwarnings
+        RUSTFLAGS: --cfg docsrs -Dwarnings
+        RUSTDOCFLAGS: --cfg docsrs -Dwarnings

Cargo.toml

@@ -24,3 +24,8 @@ tokio = { version = "1.48.0", features = ["time", "io-util"] }
 
 [profile.dev]
 opt-level = 3
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

src/lib.rs

@@ -1,6 +1,9 @@
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 pub mod sealed;
 pub mod shared;
 #[cfg(feature = "tokio")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
 pub mod split;
 pub mod stopwatch;
 pub mod sync;
@@ -15,6 +18,7 @@ pub mod prelude {
     pub use crate::sync::error as local_sync_error;
     pub use crate::sync::oneshot as local_oneshot;
     #[cfg(feature = "tokio")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub use crate::sync::pipe as local_pipe;
     pub use crate::sync::semaphore as local_semaphore;
     pub use crate::sync::unbounded as local_unbounded;

src/sync/mod.rs

@@ -5,6 +5,7 @@ pub mod condvar;
 pub mod error;
 pub mod oneshot;
 #[cfg(feature = "tokio")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
 pub mod pipe;
 pub mod semaphore;
 mod shared_state;