ruststream 0.2.4

name: Docs

on:
  push:
    branches: [main]
    paths: &docs-paths
      - docs/**
      - mkdocs.yml
      - overrides/**
      - examples/**
      - .github/workflows/docs.yml
  pull_request:
    branches: [main]
    paths: *docs-paths
  workflow_dispatch:

permissions:
  contents: read

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

jobs:
  build:
    name: Build site
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          persist-credentials: false

      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install docs toolchain
        run: pip install -r docs/requirements.txt

      - name: Build site (strict)
        run: mkdocs build --strict