static.yml

# Workflow for installing dependencies, building Sphinx docs, and deploying to GitHub Pages
name: Build and Deploy Docs
on:
  push:
    tags: ["v*"]
  
  workflow_dispatch:

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

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build-and-deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'

      - name: Install System Dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y doxygen
          
      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r ./docs/requirements.txt

      - name: Build Sphinx Documentation
        run: |
          cd docs
          make html

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Path to built Sphinx HTML documentation
          path: './docs/_build/html'

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