docs.yml

name: Build & Deploy docs site to GitHub Pages
on:
  workflow_call:

jobs:
  build:
    runs-on: ubuntu-22.04
    steps:
    - name: Checkout
      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683

    - name: Setup Python
      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b
      with:
        python-version: '3.11'
        cache: 'pip'
        cache-dependency-path: '.github/workflows/requirements/docs.txt'

    - name: Setup GitHub Pages
      id: pages
      uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b

    - name: Install Sphinx and Theme via Pip
      run: |
        pip install -r .github/workflows/requirements/docs.txt
        # create a dummy workspace to get a working ramble
        bin/benchpark setup saxpy/openmp nosite-x86_64 /tmp/workspace
        # this is gross and we should better setup ramble for people or make it a Spack package
        pip install -r /tmp/workspace/ramble/requirements.txt

    - name: Build with sphinx
      run: |
        cd docs
        make html WORKSPACE_PATH=/tmp/workspace

    - name: Check for Typos using Codespell
      run: |
        codespell

    - name: Upload artifact
      uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
      if: github.ref == 'refs/heads/develop'
      with:
        path: ./docs/_build/html

  deploy:
    needs: build
    if: github.ref == 'refs/heads/develop'

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-22.04
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e