doc.yml

name: Build Documentation
on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main

env:
  LOCALTILESERVER_BUILDING_DOCS: true

jobs:
  build-doc:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.9
      # Install everything else
      - name: Install other dependencies
        run: |
          pip install -r requirements_jupyter.txt -r requirements_doc.txt
      - name: Install localtileserver
        run: pip install -e .
      - name: Scooby Report
        run: python -c "import localtileserver;print(localtileserver.Report())"
      - name: Build Documentation
        working-directory: doc
        run: make html
      - name: Stash build
        uses: actions/upload-artifact@v3
        with:
          name: doc-build
          path: doc/build

  deploy:
    name: Publish Documentation
    runs-on: ubuntu-latest
    needs: build-doc
    if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main'
    steps:
      - uses: actions/checkout@v4
      - uses: actions/download-artifact@v3
        with:
          name: doc-build
          path: doc/build
      - name: Deploy to GH Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: doc/build/html
          cname: localtileserver.banesullivan.com