docs.yml

name: Documentation

on:
  push:
    branches: [main]

  workflow_dispatch:

concurrency:
  cancel-in-progress: true
  group: ${{ github.workflow }}

jobs:
  build:
    name: pdoc3
    runs-on: ubuntu-latest
    steps:
      - name: Check out
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Install dependencies
        run: |
          python -m pip install -U pip setuptools
          pip install .[docs]

      - name: Build docs
        run: |
          pdoc3 --html -o html aethersprite
          mv ./html ./tmp
          mv ./tmp/aethersprite ./html
          rm -rf ./tmp

      - uses: actions/upload-pages-artifact@v2
        with:
          path: html/

  deploy:
    runs-on: ubuntu-latest
    needs: build

    permissions:
      pages: write
      id-token: write

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

    steps:
      - id: deployment
        uses: actions/deploy-pages@v2