name: docs

on:
  push:
    branches: [ "master" ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v3
      - run: pip install pdoc
      - run: pdoc -o docs/ --favicon "https://pictshare.net/e73ask.png" --logo "https://pictshare.net/sco723.png" --footer-text "\"Here's the plan - when someone uses a feature you don't understand, simply shoot them.\" - Tim Peters" discord
# everything below is copied from the pdoc repo
      - run: tar --directory docs/ -hcf artifact.tar .
      - uses: actions/upload-artifact@v3
        with:
            name: github-pages
            path: ./artifact.tar
            
  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