ballistica/.github/workflows/deploy_docs.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
        # Remove this once we upgrade to 3.12.
      - name: Install typing_extensions (temp)
        run: python3.11 -m pip install typing_extensions
      - name: Install pip requirements
        run: tools/pcommand install_pip_reqs
      - name: Build documentation
        run: make docs-sphinx 
      - name: Upload the build
        uses: actions/upload-artifact@v4
        with:
          name: sphinx_html_docs
          path: build/sphinx

  deploy:
    # Add a dependency to the build job
    needs: build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
        with:
          artifact_name: sphinx_html_docs