name: docs

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

jobs:
  check:
    runs-on: [self-hosted, pod]
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install checker dependencies
        run: |
          python3 -m venv .venv
          .venv/bin/python -m pip install --disable-pip-version-check -r requirements-docs.txt
      - name: Test checker
        run: .venv/bin/python -m unittest discover -s tests -v
      - name: Check documentation
        run: .venv/bin/python scripts/check_docs.py
      - name: Check whitespace
        run: git show --format= --check HEAD