docs.yml

name: Docs (build check)

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "README.md"
      - "CONTRIBUTING.md"
      - "mkdocs.yml"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "README.md"
      - "CONTRIBUTING.md"
      - "mkdocs.yml"
      - ".github/workflows/docs.yml"

permissions:
  contents: read

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0
      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
        with:
          python-version: "3.12"
      - run: uv sync --locked --extra docs
      - run: uv run --extra docs mkdocs build --strict
        env:
          # mkdocs-material prints an advisory about upstream MkDocs 2.0 on every
          # build. It is not a defect here: pyproject pins mkdocs<2, so the
          # incompatibility it warns about cannot arise. NO_MKDOCS_2_WARNING is
          # the vendor's own documented off-switch (material/plugins/__init__.py).
          # justfile already sets this; CI must match or the two gates disagree.
          NO_MKDOCS_2_WARNING: "1"