Skip to content

Merge pull request #40 from katelouie/dependabot/github_actions/actio… #54

Merge pull request #40 from katelouie/dependabot/github_actions/actio…

Merge pull request #40 from katelouie/dependabot/github_actions/actio… #54

Workflow file for this run

name: Docs Validation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install system dependencies
run: sudo apt-get install -y graphviz
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[dev]"
- name: Run documentation validation
run: pytest -m "docs or notebooks"
# Build the Sphinx site so a sphinx/plugin break is caught at PR time.
# Read the Docs only builds after merge to main, so without this a broken
# docs build would land before anyone notices. Non-strict (no -W): the site
# currently emits many pre-existing warnings, so we fail only on hard build
# errors, not warnings.
- name: Build Sphinx docs
run: |
pip install -r docs/requirements.txt
python -m sphinx -b html docs docs/_build/html