Merge pull request #237 from unkcpz/fix/235/keyring-doc-xplat

doc: cross-platform with target tags

Fixes #235.

Author: brotskydotcom

.github/workflows/doctest.yaml

@@ -0,0 +1,38 @@
+name: Docs Build
+
+on: [ workflow_dispatch, pull_request ]
+
+jobs:
+  doc_build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: 
+          - x86_64-unknown-linux-gnu
+          - aarch64-apple-darwin
+          - aarch64-apple-ios
+          - x86_64-pc-windows-msvc
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies (linux only)
+        if: ${{ matrix.target == 'x86_64-unknown-linux-gnu' }}
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libdbus-1-dev pkg-config
+
+      - name: Install Rust nightly
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          target: ${{ matrix.target }}
+          toolchain: nightly
+          components: rust-src
+
+      - name: Build docs
+        run: |
+          FEATURES="apple-native, windows-native, linux-native-sync-persistent, crypto-rust"
+          RUSTDOCFLAGS="--cfg docsrs" \
+            cargo +nightly doc --no-deps --features "$FEATURES" --target ${{ matrix.target }} -Zbuild-std
+

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,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_cfg))]
 /*!
 
 # Keyring
@@ -204,6 +205,7 @@ 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_attr(docsrs, doc(cfg(target_os = "linux")))]
 pub mod keyutils;
 #[cfg(all(
     target_os = "linux",
@@ -217,6 +219,10 @@ pub use keyutils as default;
     any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"),
     any(feature = "sync-secret-service", feature = "async-secret-service"),
 ))]
+#[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"),
@@ -235,6 +241,7 @@ pub use secret_service as default;
         feature = "linux-native-async-persistent",
     )
 ))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "linux")))]
 pub mod keyutils_persistent;
 #[cfg(all(
     target_os = "linux",
@@ -265,13 +272,15 @@ pub use mock as default;
 // pick the Apple keystore
 //
 #[cfg(all(target_os = "macos", feature = "apple-native"))]
+#[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"))]
+#[cfg_attr(docsrs, doc(cfg(target_os = "ios")))]
 pub mod ios;
 #[cfg(all(target_os = "ios", feature = "apple-native"))]
 pub use ios as default;
@@ -282,6 +291,7 @@ pub use mock as default;
 // pick the Windows keystore
 //
 #[cfg(all(target_os = "windows", feature = "windows-native"))]
+#[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;