name: Rust Documentation
on:
pull_request:
branches: [ main ]
env:
CARGO_TERM_COLOR: always
jobs:
docs:
name: Check documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Rust toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- name: Cache dependencies
uses: actions/cache@v3
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-
- name: Check documentation
uses: actions-rs/cargo@v1
with:
command: doc
args: --no-deps --document-private-items --all-features