docs.yml

# SPDX-FileCopyrightText: 2026 Tarik Hamedovic
# SPDX-License-Identifier: CC-BY-SA-4.0

name: Deploy Sphinx Docs

on:
  push:
    branches:
      - main
      - dev/documentation
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: github-pages
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install documentation dependencies
        working-directory: docs
        run: pip install -r requirements.txt

      - name: Build HTML documentation
        working-directory: docs
        run: make html

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/build/html

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4