documentation.yml

name: Build the documentation

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  build:
    # Functionality for testing documentation builds on multiple OSes and Python versions
    name: Build docs (${{ matrix.python-version }}, ${{ matrix.os }})
    runs-on:
      windows-latest
    defaults:
      run:
        shell: bash -l {0}
    strategy:
      matrix:
        python-version: ["3.11"]

    steps:
      # Grap the latest commit from the branch
      - name: Checkout the branch
        uses: actions/checkout@v2.3.1
        with:
          persist-credentials: false

      # Install Poetry and build the documentation
      - name: Install and configure Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.8.3
          virtualenvs-create: true
          virtualenvs-in-project: false
          installer-parallel: true

      - name: Build the documentation with Sphinx
        run: |
          poetry install --all-extras
          sudo apt install pandoc
          pip install pandoc
          cd docs
          poetry run sphinx-build -b html source build/html