docs-build.yaml

# Builds the Sphinx documentation
name: Docs Build

on:
  pull_request:
    branches: [main]
    paths:
      - docs/**
      - cneuromax/**
      - .github/workflows/docs-build.yaml

jobs:
  docs-build:
    runs-on: self-hosted
    steps:
      - name: Checkout the GitHub repo
        uses: actions/checkout@v4
      - name: Build the CNeuroMax image
        run: podman build -t cneuromod/cneuromax:docs -f Dockerfile .
      - name: Build the documentation
        run: >
          podman run --rm -v $PWD:/cneuromax -w /cneuromax
          cneuromod/cneuromax:docs
          sphinx-build -b html ./docs/ ./docs/build/
      - name: Upload the documentation as an artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: ./docs/build/
  deploy:
    needs: docs-build
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: self-hosted
    steps:
      - name: Deploy to Github Pages
        uses: actions/deploy-pages@v4
        with:
          artifact_name: docs