Skip to content

Commit

Permalink
Add docs build to CI
Browse files Browse the repository at this point in the history
  • Loading branch information
fjarri committed Oct 21, 2024
1 parent eb2a166 commit 2d355f4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion manul/src/session/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down

0 comments on commit 2d355f4

Please sign in to comment.