CI: run cargo doc (#775)

Ensures docs build successfully

Author: tarcieri

.github/workflows/workspace.yml

@@ -1,5 +1,10 @@
 name: Workspace
 
+env:
+  CARGO_INCREMENTAL: 0
+  RUSTFLAGS: "-Dwarnings"
+  RUSTDOCFLAGS: "-Dwarnings"
+
 on:
   pull_request:
     paths-ignore:
@@ -21,6 +26,15 @@ jobs:
           components: clippy
       - run: cargo clippy --all -- -D warnings
 
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+      - run: cargo doc --workspace --all-features
+
   rustfmt:
     runs-on: ubuntu-latest
     steps:

pbkdf2/src/lib.rs

@@ -38,8 +38,7 @@
 //! # }
 //! ```
 //!
-//! If you want to use a different PRF, then you can use [`pbkdf2`][crate::pbkdf2]
-//! and [`pbkdf2_array`] functions.
+//! If you want to use a different PRF, then you can use [`pbkdf2`] and [`pbkdf2_array`] functions.
 //!
 //! This crates also provides the high-level password-hashing API through
 //! the [`Pbkdf2`] struct and traits defined in the
@@ -171,8 +170,7 @@ where
     Ok(())
 }
 
-/// A variant of the [`pbkdf2`][crate::pbkdf2] function which returns an array
-/// instead of filling an input slice.
+/// A variant of the [`pbkdf2`] function which returns an array instead of filling an input slice.
 ///
 /// ```
 /// use hex_literal::hex;
@@ -197,7 +195,8 @@ where
     pbkdf2::<PRF>(password, salt, rounds, &mut buf).map(|()| buf)
 }
 
-/// A variant of the [`pbkdf2`][crate::pbkdf2] function which uses HMAC for PRF.
+/// A variant of the [`pbkdf2`] function which uses HMAC for PRF.
+///
 /// It's generic over (eager) hash functions.
 ///
 /// ```

sha-crypt/src/errors.rs

@@ -2,6 +2,9 @@
 
 use core::fmt;
 
+#[cfg(doc)]
+use crate::Params;
+
 /// Result type for the `sha-crypt` crate with its [`Error`] type.
 pub type Result<T> = core::result::Result<T, Error>;