.github/workflows/build_docs.yaml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

name: "Publish Docs"

on:
  pull_request:
    paths:
      - 'apidoc/**'
      - 'docs/**'
      - 'include/**'
  push:
    branches:
      - main
    paths:
      - 'apidoc/**'
      - 'docs/**'
      - 'include/**'

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

permissions:
  contents: write

jobs:
  docs:
    runs-on: ubuntu-24.04

    steps:
      - uses: actions/checkout@v6.0.1
        with:
          fetch-depth: 1

      - uses: actions/setup-python@v6
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y doxygen
          pip install -r docs/requirements.txt

      - name: Build API
        run: |
          cd ./apidoc
          doxygen
          cd -

      - name: Build Docs
        run: |
            cd docs
            make html
            mkdir -p /tmp/site
            cp -r ./_build/html/* /tmp/site/
            touch /tmp/site/.nojekyll
            cd -

      - name: Deploy to gh-pages
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          git config --global user.name 'GitHub Actions'
          git config --global user.email 'actions@github.com'

          git checkout --orphan gh-pages-tmp
          git rm --quiet -rf .
          cp -r /tmp/site/. .
          git add --all
          git commit -m "Publish docs from commit ${{ github.sha }}"
          git push -f origin gh-pages-tmp:gh-pages