experiment doccfg with attr docrs

Author: unkcpz

.github/workflows/ci.yaml

@@ -143,5 +143,5 @@ jobs:
           toolchain: nightly
           targets: x86_64-unknown-linux-gnu, aarch64-apple-darwin, aarch64-apple-ios, x86_64-pc-windows-msvc
 
-      - name: docs bulid check
+      - name: docs build check
         run: bash build-xplat-docs.sh

build-xplat-docs.sh

@@ -9,5 +9,5 @@ TARGETS=(
 )
 
 for TARGET in "${TARGETS[@]}"; do
-    cargo +nightly doc --no-deps --features "$FEATURES" --target "$TARGET" -Zbuild-std $OPEN_DOCS
+    RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --features "$FEATURES" --target "$TARGET" -Zbuild-std $OPEN_DOCS
 done

src/lib.rs

@@ -1,4 +1,4 @@
-#![feature(doc_cfg)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 /*!
 
 # Keyring
@@ -204,11 +204,8 @@ compile_error!("This crate cannot use both the sync and async versions of any cr
 //
 // pick the *nix keystore
 //
-#[cfg(any(
-    all(target_os = "linux", feature = "linux-native"),
-    all(target_os = "linux", feature = "linux-native-sync-persistent", doc)
-))]
-#[doc(cfg(all(target_os = "linux")))]
+#[cfg(all(target_os = "linux", feature = "linux-native"))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "linux")))]
 pub mod keyutils;
 #[cfg(all(
     target_os = "linux",
@@ -218,14 +215,14 @@ pub mod keyutils;
 ))]
 pub use keyutils as default;
 
-#[cfg(any(
-    all(
-        any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"),
-        any(feature = "sync-secret-service", feature = "async-secret-service"),
-    ),
-    all(target_os = "linux", feature = "linux-native-sync-persistent", doc),
+#[cfg(all(
+    any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"),
+    any(feature = "sync-secret-service", feature = "async-secret-service"),
 ))]
-#[doc(cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd")))]
+#[cfg_attr(
+    docsrs,
+    doc(cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd")))
+)]
 pub mod secret_service;
 #[cfg(all(
     any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"),
@@ -237,17 +234,14 @@ pub mod secret_service;
 ))]
 pub use secret_service as default;
 
-#[cfg(any(
-    all(
-        target_os = "linux",
-        any(
-            feature = "linux-native-sync-persistent",
-            feature = "linux-native-async-persistent",
-        )
-    ),
-    all(target_os = "linux", feature = "linux-native-sync-persistent", doc),
+#[cfg(all(
+    target_os = "linux",
+    any(
+        feature = "linux-native-sync-persistent",
+        feature = "linux-native-async-persistent",
+    )
 ))]
-#[doc(cfg(all(target_os = "linux")))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "linux")))]
 pub mod keyutils_persistent;
 #[cfg(all(
     target_os = "linux",
@@ -278,15 +272,15 @@ pub use mock as default;
 // pick the Apple keystore
 //
 #[cfg(all(target_os = "macos", feature = "apple-native"))]
-#[doc(cfg(all(target_os = "macos")))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
 pub mod macos;
 #[cfg(all(target_os = "macos", feature = "apple-native"))]
 pub use macos as default;
 #[cfg(all(target_os = "macos", not(feature = "apple-native")))]
 pub use mock as default;
 
 #[cfg(all(target_os = "ios", feature = "apple-native"))]
-#[doc(cfg(all(target_os = "ios")))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "ios")))]
 pub mod ios;
 #[cfg(all(target_os = "ios", feature = "apple-native"))]
 pub use ios as default;
@@ -297,7 +291,7 @@ pub use mock as default;
 // pick the Windows keystore
 //
 #[cfg(all(target_os = "windows", feature = "windows-native"))]
-#[doc(cfg(all(target_os = "windows")))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "windows")))]
 pub mod windows;
 #[cfg(all(target_os = "windows", not(feature = "windows-native")))]
 pub use mock as default;