Skip to content

Commit

Permalink
feat(docs): Check rustdoc more strictly (#1185)
Browse files Browse the repository at this point in the history
This makes our docs checking a bit stricter:

    rustdoc warnings are now fatal in ci.
    we test docs of the entire workspace...
    we test private items as well

This includes the fixes needed to make this all work.
  • Loading branch information
flub authored Jul 7, 2023
1 parent 5dca71b commit e210403
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
env:
RUST_BACKTRACE: 1
RUSTFLAGS: -Dwarnings
RUSTDOCFLAGS: -Dwarnings
MSRV: "1.65"

jobs:
Expand Down Expand Up @@ -249,7 +250,7 @@ jobs:
run: cargo fmt --all -- --check

- name: Docs
run: cargo doc
run: cargo doc --workspace --all-features --no-deps --document-private-items

clippy_check:
runs-on: ubuntu-latest
Expand Down

0 comments on commit e210403

Please sign in to comment.