docs.yml

name: Build docs

on:

  pull_request:
    branches:
      - main
  push:
    branches:
      - main
    tags:
      - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
  workflow_dispatch:

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@v2
        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
    if: contains(github.ref, 'tags')
    steps:
    - uses: actions/checkout@v3
    - uses: actions/download-artifact@v3
      with:
        name: docs

    - name: Push to GitHub pages
      uses: JamesIves/github-pages-deploy-action@v4
      with:
        folder: html
        ssh-key: ${{ secrets.DEPLOY_KEY }}
        repository-name: napari-matplotlib/napari-matplotlib.github.io