docs.yml

name: Build docs

on:
  pull_request:
    branches:
      - main

jobs:
  build-docs:
    name: Build & Upload Artifact
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-python@v3
        with:
          python-version: "3.10"

      - uses: tlambert03/setup-qt-libs@v1

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install ".[docs]"
          sudo apt install graphviz --yes

      - name: Build Docs
        uses: aganders3/headless-gui@v1
        with:
          run: make html
          working-directory: ./docs

      - name: Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: docs
          path: docs/_build

  upload-docs:
    name: Upload docs to GitHub pages
    runs-on: ubuntu-latest
    needs: build-docs
    steps:
    - uses: actions/download-artifact@v3
      with:
        name: docs

    - name: Push to GitHub pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./docs/_build/html
        destination_dir: dev