quality_check_docs.yml

name: Quality check - Build docs

# PROCESS
#
# 1. Install all dependencies required to build the docs
# 2. Build the docs

# USAGE
#
# Always triggered on new PRs, PR changes and PR merge.


on:
  pull_request:
    paths:
      - "docs/**"
      - "examples/**"
      - "mkdocs.yml"
    branches:
      - develop
  push:
    paths:
      - "docs/**"
      - "examples/**"
      - "mkdocs.yml"
    branches:
      - develop

permissions:
  contents: read

jobs:
  build_docs:
    runs-on: ubuntu-latest
    permissions:
      contents: read  # checkout code only
    steps:
      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
      - name: Set up Python
        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
        with:
          python-version: 3.14
      - name: Install doc generation dependencies
        run: |
          cat docs/requirements.txt
          pip install --require-hashes -r docs/requirements.txt
      - name: Build docs
        run: |
          rm -rf site
          mkdocs build