lint-docs.yml

name: Verify documentation
on:
  push:
    branches: ["main", "master"]
  pull_request:
    branches: ["main", "master"]

jobs:
  verify-docs:
    name: Check Documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"
      - name: Install and configure Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1
      - name: Install dependencies
        run: |
          poetry env use '3.10'
          poetry install --extras=testing
      - name: Build docs with MkDocs
        run: |
          make docs
      - name: Check Markdown links
        uses: gaurav-nelson/github-action-markdown-link-check@v1