docs.yml

# Simple workflow for building documentation for PR testing
name: Build documentation

# On a pull request this will build the html documentation
# and create an artifact. It does this by using the cmake
# build target doc_html. Note that this requires installing a little
# more than is technically required for building the documentation in
# order to satisfy our current cmake configurations e.g. spirv-tools
on:
  pull_request:
    paths:
      - doc/**
      - .github/workflows/docs.yml

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

permissions: {}

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: 3.9

      - name: Install apt package
        run: |
          sudo apt-get update
          sudo apt-get install -y doxygen virtualenv

      - name: Install prerequisites
        run: python -m pip install -r doc/requirements.txt

      - name: Build Documentation
        working-directory: ${{github.workspace}}
        run: |
          cmake -DCA_ENABLE_API=cl -DCMAKE_BUILD_TYPE=Debug -DCA_RUNTIME_COMPILER_ENABLED=OFF -DCA_CL_ENABLE_OFFLINE_KERNEL_TESTS=OFF -DOCL_EXTENSION_cl_khr_il_program=OFF -Bbuild_doc
          cmake --build build_doc --target doc_html

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ${{github.workspace}}/build_doc/doc/html