docs.yml

# This workflow is just to test that the docs build successfully.
name: docs
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true
on:
  workflow_dispatch:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
permissions:
  contents: write
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
        with:
          python-version: "3.10"
      - name: "Install dependancies"
        run: python -m pip install -e ".[dev]"
      - name: "Build Docs"
        run: mkdocs build --clean --strict