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@6c3c2f2c1c457b00c10c4848d6f5491db3b629df # v2.18.0
        with:
          egress-policy: audit

      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.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@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs
          path: docs/build