infra-generate-documentation.yml

# SPDX-FileCopyrightText: 2025 ETH Zurich and University of Bologna
#
# SPDX-License-Identifier: Apache-2.0

---
name: Infrastructure • Generate Documentation

"on":
  push:
    branches:
      - "**"
    tags:
      - "v*.*.*"
  pull_request:
  workflow_dispatch:

permissions:
  contents: write

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - name: Install dependencies
        run: |
          pip install . --extra-index-url=https://pypi.ngc.nvidia.com
          pip install -r requirements-dev.txt
      - name: Sphinx build
        run: |
          sphinx-build docs _build
      - name: Prepare Multipages
        uses: xeratec/gh-pages-multibranch@pr/support_tags
        if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
        with:
          directory: _build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch'}}
        with:
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: _build/
          force_orphan: true