test_docs.yml

name: Test documentation

on:
  pull_request:

jobs:
  test-docs:
    # Functionality for testing documentation builds on multiple OSes and Python versions
    name: Build docs (${{ matrix.python-version }}, ${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    concurrency:
      group: ${{ github.head_ref }}
      cancel-in-progress: true
    defaults:
      run:
        shell: bash -l {0}
    strategy:
      matrix:
        os: ["ubuntu-latest"]
        python-version: ["3.10"]

    steps:
      # Grap the latest commit from the branch
      - name: Checkout the branch
        uses: actions/checkout@v3.5.2
        with:
          persist-credentials: false

      # Create a virtual environment
      - name: create Conda environment
        uses: conda-incubator/setup-miniconda@v2
        with:
          auto-update-conda: true
          python-version: ${{ matrix.python-version }}

      # Install Hatch
      - name: Install Hatch
        uses: pypa/hatch@install

      - name: Build the documentation with MKDocs
        run: |
          conda install pandoc
          hatch run docs:build