Merge pull request #38 from fjarri/docs-build

Add docs build to CI

.github/workflows/ci.yml

@@ -80,6 +80,18 @@ jobs:
           profile: minimal
       - run: cargo clippy --all --all-features --tests --benches -- -D warnings
 
+  # Mimics the setup of docs.rs, but fails on warnings
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          override: true
+          profile: minimal
+      - run: env RUSTDOCFLAGS='--cfg docsrs -D warnings' cargo doc --all-features
+
   rustfmt:
     runs-on: ubuntu-latest
     steps:

manul/src/session/session.rs

@@ -48,7 +48,7 @@ pub trait SessionParameters {
         + Send
         + Sync;
 
-    /// The signature type corresponding to [`Signer`] and [`Verifier`].
+    /// The signature type corresponding to [`Signer`](`Self::Signer`) and [`Verifier`](`Self::Verifier`).
     type Signature: 'static + Debug + Clone + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync;
 }