gh-pages.yaml

name: render

on:
  push:
    branches:
      - master
  workflow_dispatch:
  pull_request:

jobs:
  build:
    name: "Build Documentation"
    runs-on: "ubuntu-latest"

    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
          submodules: recursive

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Install Tox
        run: pip install tox

      - name: Build Documentation
        run: |
          tox -e doc
          touch .tox/docs/.nojekyll

      - name: Upload Pages Artifact
        id: artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: .tox/docs

  deploy:
    needs: build
    runs-on: ubuntu-latest
    name: "Deploy Documentation"
    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}

    permissions:
      pages: write
      id-token: write

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

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2