doc.yml

name: Publish documentation

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

  # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages


# 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

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

jobs:
  build:
    name: Publish
    runs-on: ubuntu-latest
    environment: pypi
    strategy:
      matrix:
        python-version: ['3.9']
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com            
      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          version: "0.5.18"    
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: make install 
      - name: Build Documentation
        run: uv run poe docs
      - name: Publish Documentation
        run: uv run poe docs-publish