docs.yml

---
name: Check documentation

"on":
  schedule:
    - cron: "0 1 * * *" # everyday at 1am
  push:
    paths:
      - "**.rst"
      - "docs/**"
  pull_request:
    paths:
      - "**.rst"
      - "docs/**"

permissions:
  contents: read

jobs:
  docs:
    name: Build documentation & check links
    runs-on: ubuntu-latest
    steps:
      - name: Harden the runner (Audit all outbound calls)
        uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
        with:
          egress-policy: audit

      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
        with:
          python-version: "3.11"

      - name: Upgrade pip
        run: |
          pip install -U pip
          pip --version

      - name: Install Tox
        run: |
          pip install tox
          tox --version

      - name: Build documentation
        run: tox
        env:
          TOXENV: docs

      - name: Upload documentation
        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        with:
          name: docs
          path: docs/build