static.yml

# Simple workflow for deploying static content to GitHub Pages
name: Documentation

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.10
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install wheel
          pip install -e .[docs]
          pip install "dense_basis@git+https://github.com/kartheikiyer/dense_basis"
          sudo apt install pandoc
      - name: Download test data
        run: |
          synthesizer-download --test-grids -d tests/test_grid/ --dust-grid
          synthesizer-download -d tests/data --camels-data
      - name: Sphinx Build
        run: |
          cd docs
          make clean
          make html SPHINXOPTS="-j 2"
          cd ../
      - name: Upload static files as artifact
        id: deployment
        uses: actions/upload-pages-artifact@v3
        with:
          name: github-pages
          path: docs/build/html/

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Download artifact
        uses: actions/download-artifact@v4
        with:
          name: github-pages
          path: docs/build/html/
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4