Skip to content

Commit

Permalink
docs / ci: Add CI for docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys committed Nov 16, 2024
1 parent 2f281f3 commit 44be1de
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/check-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Check documentation

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

env:
CARGO_TERM_COLOR: always
RUSTDOCFLAGS: '--cfg docsrs -D warnings'

jobs:
# We test documentation using nightly to match docs.rs.
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: Swatinem/rust-cache@v2
- name: Install nightly Rust
run: rustup default nightly
- name: Check docs
run: cargo doc --workspace --no-deps --document-private-items

0 comments on commit 44be1de

Please sign in to comment.