tests_docs.yml

# Simple workflow for deploying static content to GitHub Pages
name: Test build of docs

on:

  pull_request:

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Get changed files
        id: changed-files
        uses: tj-actions/changed-files@v44
        with:
          files: "docs/*"

      - name: Install Poetry
        if: steps.changed-files.outputs.any_changed == 'true'
        run: pipx install poetry
      - name: Install Python
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'
          cache: poetry
      - name: Setup Pages
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: actions/configure-pages@v2
      - name: Install local Python package
        if: steps.changed-files.outputs.any_changed == 'true'
        run: poetry install --with docs
      - name: Setup Pages
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: actions/configure-pages@v3
      - name: Build docs
        if: steps.changed-files.outputs.any_changed == 'true'
        run: cd docs && poetry run make html