name: website

# build the documentation whenever there are new commits on main

on:

  push:

    branches:

      - main

    # Alternative: only build for tags.

    # tags:

    #   - '*'

# security: restrict permissions for CI jobs.

permissions:

  contents: read

jobs:

  # Build the documentation and upload the static HTML files as an artifact.

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - uses: actions/setup-python@v4

        with:

          python-version-file: .github/python-version.txt

      # ADJUST THIS: install all dependencies (including pdoc)

      - run: pip install pdoc

      - run: python setup.py install

      - run: pip install -r requirements.txt

      # 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: pdoc -o docs/ gpsa

      - uses: actions/upload-pages-artifact@v1

        with:

          path: docs/

  # Deploy the artifact to GitHub pages.

  # This is a separate job so that only actions/deploy-pages has the necessary permissions.

  deploy:

    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@v1