build_docs.yml

name: docs

on:
  push:
    branches:
      - main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    if: github.repository_owner == 'TurtleThread'
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Set up Python with TKinter and a virtual X11 frame buffer
        run: |
          sudo add-apt-repository ppa:inkscape.dev/stable
          sudo apt-get update
          sudo apt-get install tk-dev python3-tk python3 python3-pip xvfb make ghostscript inkscape
          # To silence warning about accessibility in Inkscape:
          # See https://gist.github.com/jeffcogswell/62395900725acef1c0a5a608f7eb7a05
          sudo apt-get install at-spi2-core
      - name: Install turtlethread
        run: |
          python -m pip install --upgrade pip
          pip3 install --user .[dev,docs]
      - name: Build docs
        run: |
          # Start virtual display driver
          export DISPLAY=:12
          Xvfb $DISPLAY -screen 0 1920x1080x24 2>/tmp/Xvfb.log & sleep 1
          # build docs
          cd docs
          make html
          cd ..

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: docs/_build

  # Deployment job
  deploy_docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2