doc.yml

name: Documentation

on:
  push:
    branches: [ trunk ]

env:
  CARGO_TERM_COLOR: always
  CARGO_INCREMENTAL: 0
  CARGO_NET_RETRY: 10
  RUSTUP_MAX_RETRIES: 10
  RUST_BACKTRACE: 1

jobs:
  rustdoc:
    runs-on: ubuntu-22.04

    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      # Rust doc
      - uses: dtolnay/rust-toolchain@nightly
      - name: Generate Rust Docs
        run: cargo +nightly doc --all --all-features --no-deps
      # Additional files
      - run: sudo chmod +x ./docs/build.sh
      - run: sudo ./docs/build.sh
      # Deployments
      - name: Deploy Docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: ./target/doc
          force_orphan: true