documentation.yml

name: Documentation Build

on:
  push:
    branches:
      - main
  pull_request:

permissions:
  contents: read

jobs:
  documentation-build:
    name: documentation-build
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install documentation dependencies
        run: python -m pip install -e .[docs]

      - name: Install Doxygen and Graphviz
        run: sudo apt-get update && sudo apt-get install --yes doxygen graphviz

      - name: Create the Doxygen output directory
        run: mkdir -p build/doxygen

      - name: Build Doxygen reference
        run: doxygen Doxyfile

      - name: Copy Doxygen output into MkDocs
        run: python scripts/copy_doxygen_output_into_mkdocs.py

      - name: Build MkDocs site
        run: mkdocs build --strict

      - name: Upload documentation artifact
        uses: actions/upload-artifact@v7
        with:
          name: documentation-site
          path: site