plankapy/.forgejo/workflows/pdoc.yml

name: website

# build the documentation whenever there are new commits on main
on:
  push:
    branches:
      - main
    # Alternative: only build for tags.
    # tags:
    #   - '*'
  workflow_dispatch:
## security: restrict permissions for CI jobs.
permissions:
  contents: read

jobs:
  # Build the documentation and upload the static HTML files as an artifact.
  build:
    container: 
      image: node:20-bookworm
    steps:
      - name: Install dependencies
        run: |
          apt update
          apt install -y python3 python3-pip
      # ADJUST THIS: install all dependencies (including pdoc)
      #- run: pip install -e .
      #- run: pip install --upgrade pip
      - run: pip install pdoc
      - run: pip install requests
      #- run: pip install json
      # ADJUST THIS: build your documentation into docs/.
      # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
      - run: python3 -m pdoc -d markdown -o docs src/plankapy/plankapy.py

      - uses: forgejo/upload-artifact@v4
        with:
          path: docs