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@c6295a65d1254861815972266d5933fd6e532bdf # v2.11.1
        with:
          egress-policy: audit

      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.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@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.2.1
        with:
          name: docs
          path: docs/build