Skip to content

Check documentation #513

Check documentation

Check documentation #513

Workflow file for this run

---
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@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
with:
egress-policy: audit
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.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@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: docs
path: docs/build