doc.yml

name: Documentation

on:
  push:
    branches:
      - main

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: 'pages'
  cancel-in-progress: true

jobs:

  doc:

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

    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3

    - name: Setup Pages
      uses: actions/configure-pages@v3

    - name: Set up PDM
      uses: pdm-project/setup-pdm@v3
      with:
        cache: true
        cache-dependency-path: pyproject.toml

    - name: Install dependencies
      run: pdm install -dG maintenance -dG docs

    - name: Build documentation
      run: pdm docs build

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v1
      with:
        path: 'site'

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