git_pages.yml

name: Generate and publish docs

on:
  pull_request:
    branches: ["main"]
  # 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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup Python
        uses: actions/setup-python@v5.3.0 # v5.3.0
        with:
          python-version: '3.10'
      - name: Install Dependencies
        run: |
          python -m pip install --quiet --upgrade pip setuptools wheel
          python -m pip install -r docs/hpcdoc/source/requirements.txt
      - name: Build Docs
        run: |
          cd docs/hpcdoc
          make html
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3.0.1 # v3.0.1
        with:
          path: 'docs/hpcdoc/build/html'
  deploy:
    needs: 'build'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5.0.0 # v5.0.0
        with:
          enablement: true  #
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4.0.5 # v4.0.5