Skip to content

Check documentation #668

Check documentation

Check documentation #668

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@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.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