docs.yml

name: Docs

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  docs:
    name: Check docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
      - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
      - run: uv sync --group docs
      # Fast source-level guards that need no built site, so they run before the (slower)
      # build for a quick failure: every public export is in the API reference, and no
      # docstring/Markdown carries reStructuredText markup that MkDocs won't render.
      - run: uv run python ci/check_documented_exports.py docs/api
      - run: uv run python ci/lint_docs.py
      # --strict turns warnings into errors, so a docs code block that fails to execute
      # at build time (e.g. a non-exec python fence disrupting a later exec="true" block)
      # fails CI instead of merging as a silent warning.
      - run: uv run mkdocs build --strict
        env:
          DISABLE_MKDOCS_2_WARNING: "true"
          NO_MKDOCS_2_WARNING: "true"
      - run: uv run python ci/check_unlinked_types.py
        continue-on-error: true