docs.yml

name: docs
on: [push, pull_request]

# 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:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the repository
        uses: actions/checkout@main

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

      - name: Install uv
        uses: astral-sh/setup-uv@v3
        with:
          version: "0.4.4"

      - name: Install swmm-pandas
        run: |
          uv sync --all-extras -p 3.12

      - name: Sphinx build
        run: uv run sphinx-build docs/ docs/build

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload build
          path: './docs/build'

  deploy:
    if: startsWith(github.event.ref, 'refs/tags/v')
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4