docs.yml

name: Docs

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

env:
  CARGO_TERM_COLOR: always
    
jobs:
  doc:
    name: Docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
        with:
          submodules: "recursive"
      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - name: Run cargo doc
        run: cargo doc --workspace --verbose --no-deps --features=all
      - name: Check READMEs
        run: |
          cargo install cargo-rdme
          return=true
          for dir in rustsat tools cadical kissat minisat glucose ipasir capi pyapi; do
            cd ${dir}
            if ! cargo rdme --check; then
              echo "failed for ${dir}"
              return=false
            fi
            cd ..
          done
          ${return}