doc: cross-platform with target tags

.github/workflows/ci.yaml

@@ -129,3 +129,23 @@ jobs:
 
       - name: Clippy check
         run: cargo clippy --features=linux-native -- -D warnings
+
+  doc_build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch head
+        uses: actions/checkout@v4
+
+      - name: Install rust stable
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: nightly
+          target: 
+            - x86_64-unknown-linux-gnu
+            - aarch64-apple-darwin
+            - aarch64-apple-ios
+            - x86_64-pc-windows-msvc
+
+      - name: docs bulid check
+        run: bash build-xplat-docs.sh

Cargo.toml

@@ -77,4 +77,6 @@ rprompt = "2"
 whoami = "1.5"
 
 [package.metadata.docs.rs]
-features = ["apple-native", "windows-native", "sync-secret-service", "crypto-rust"]
+default-target = "x86_64-unknown-linux-gnu"
+targets = ["x86_64-unknown-linux-gnu", "aarch64-apple-darwin", "aarch64-apple-ios", "x86_64-pc-windows-msvc"]
+features = ["apple-native", "windows-native", "linux-native-sync-persistent", "crypto-rust"]

README.md

@@ -142,6 +142,7 @@ Thanks to the following for helping make this library better, whether through co
 - @Sytten
 - @thewh1teagle
 - @tmpfs
+- @unkcpz
 - @VorpalBlade
 - @zschreur
 

build-xplat-docs.sh

@@ -1,11 +1,13 @@
 #!/bin/bash
-if [[ "$OSTYPE" == "linux"* ]]; then
-  cargo doc --no-deps --features=linux-native-sync-persistent $OPEN_DOCS
-  cargo doc --no-deps --features=sync-secret-service $OPEN_DOCS
-  cargo doc --no-deps --features=linux-native $OPEN_DOCS
-elif [[ "$OSTYPE" == "darwin"* ]]; then
-  cargo doc --no-deps --features=linux-native --target aarch64-unknown-linux-musl $OPEN_DOCS
-  cargo doc --no-deps --features=windows-native --target aarch64-pc-windows-msvc $OPEN_DOCS
-  cargo doc --no-deps --features=apple-native --target aarch64-apple-darwin $OPEN_DOCS
-  cargo doc --no-deps --features=apple-native --target aarch64-apple-ios $OPEN_DOCS
-fi
+
+FEATURES="apple-native, windows-native, linux-native-sync-persistent, crypto-rust"
+TARGETS=(
+    "x86_64-unknown-linux-gnu"
+    "aarch64-apple-darwin"
+    "aarch64-apple-ios"
+    "x86_64-pc-windows-msvc"
+)
+
+for TARGET in "${TARGETS[@]}"; do
+    cargo +nightly doc --no-deps --features "$FEATURES" --target "$TARGET" -Zbuild-std $OPEN_DOCS
+done

src/lib.rs

@@ -1,3 +1,4 @@
+#![feature(doc_cfg)]
 /*!
 
 # Keyring
@@ -203,7 +204,11 @@ compile_error!("This crate cannot use both the sync and async versions of any cr
 //
 // pick the *nix keystore
 //
-#[cfg(all(target_os = "linux", feature = "linux-native"))]
+#[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")))]
 pub mod keyutils;
 #[cfg(all(
     target_os = "linux",
@@ -213,10 +218,14 @@ pub mod keyutils;
 ))]
 pub use keyutils as default;
 
-#[cfg(all(
-    any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"),
-    any(feature = "sync-secret-service", feature = "async-secret-service"),
+#[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),
 ))]
+#[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"),
@@ -228,13 +237,17 @@ pub mod secret_service;
 ))]
 pub use secret_service as default;
 
-#[cfg(all(
-    target_os = "linux",
-    any(
-        feature = "linux-native-sync-persistent",
-        feature = "linux-native-async-persistent",
-    )
+#[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),
 ))]
+#[doc(cfg(all(target_os = "linux")))]
 pub mod keyutils_persistent;
 #[cfg(all(
     target_os = "linux",
@@ -265,13 +278,15 @@ pub use mock as default;
 // pick the Apple keystore
 //
 #[cfg(all(target_os = "macos", feature = "apple-native"))]
+#[doc(cfg(all(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")))]
 pub mod ios;
 #[cfg(all(target_os = "ios", feature = "apple-native"))]
 pub use ios as default;
@@ -282,6 +297,7 @@ pub use mock as default;
 // pick the Windows keystore
 //
 #[cfg(all(target_os = "windows", feature = "windows-native"))]
+#[doc(cfg(all(target_os = "windows")))]
 pub mod windows;
 #[cfg(all(target_os = "windows", not(feature = "windows-native")))]
 pub use mock as default;