docs: document full API on docs.rs and guard the build in CI

Author: AlfioEmanueleFresta

.github/workflows/docs.yml

@@ -0,0 +1,21 @@
+name: docs.rs build
+
+on: [push, pull_request]
+
+jobs:
+  docs:
+    name: docs.rs build
+    runs-on: ubuntu-latest
+    # Same image docs.rs uses, so missing system libraries surface here first.
+    container:
+      image: ghcr.io/rust-lang/crates-build-env/linux:latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install nightly toolchain
+        run: |
+          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly --profile minimal
+          echo "$HOME/.cargo/bin" >> "$GITHUB_PATH"
+      - name: Install cargo-docs-rs
+        run: cargo install --locked cargo-docs-rs
+      - name: Build docs the way docs.rs does
+        run: cargo +nightly docs-rs -p libwebauthn

libwebauthn/Cargo.toml

@@ -19,6 +19,14 @@ resolver = "2"
 name = "libwebauthn"
 path = "src/lib.rs"
 
+# docs.rs builds with default features only, which omits the NFC transport and
+# the virtual-device test surface. Document those too. libnfc is not available
+# in the docs.rs build environment, so the libnfc backend is left out and NFC is
+# documented through the pcsc backend instead.
+[package.metadata.docs.rs]
+features = ["nfc-backend-pcsc", "virt"]
+rustdoc-args = ["--cfg", "docsrs"]
+
 [features]
 default = []
 nfc = ["apdu-core", "apdu"]