name: Docs
on:
push:
branches: [main]
pull_request:
workflow_dispatch:
permissions:
contents: read
env:
CARGO_TERM_COLOR: always
RUSTDOCFLAGS: "-D warnings"
jobs:
docs:
name: Build Documentation
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
- name: Setup toolchain
uses: dtolnay/rust-toolchain@stable
- name: Setup Rust Cache
uses: Swatinem/rust-cache@aa7c1c80a07a27a84c0aa76d0cef0aad3830e330 with:
cache-on-failure: true
- name: Build docs
run: |
cargo doc --no-deps --locked \
--package fynd-core \
--package fynd-rpc-types \
--package fynd-rpc \
--package fynd-client