docs.yml

name: docs

# Build the documentation on pull request and when a new release is published
on:
  pull_request:
    branches:
      - main
  release:
    types: [published]

permissions:
  contents: read

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - run: pip install -e '.[docs]'
      - run: DOC_ALLOW_EXEC=1 pdoc --docformat google -o docs/ snputils
      - uses: actions/upload-pages-artifact@v3
        with:
          path: docs/

  deploy:
    # Only run this job if the workflow was triggered by a release
    if: github.event_name == 'release'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4