doc.yml

name: Documentation

on:
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production
# deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build-doc:
    runs-on: ubuntu-latest

    environment:
      name: github-pages

    steps:
      - uses: actions/checkout@v4
      - uses: pdm-project/setup-pdm@v4
        with:
          python-version: 3.10.5
      - name: Build pages
        run: |
          pdm install --group doc
          cd docs && pdm run mkdocs build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './docs/site'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4