documentation.yml

name: publish website

on:
  workflow_dispatch:
  push:
    branches:
      - main
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}
    steps:
    - uses: actions/checkout@v4

    - uses: actions/setup-python@v5
      with:
        python-version: '3.13'

    - uses: pandoc/actions/setup@v1

    - name: install dependencies
      run: pip install sphinx nbsphinx furo .

    - name: Build website
      run: sphinx-build docs docs-artifacts

    - name: Upload website artifacts
      uses: actions/upload-pages-artifact@v3
      with:
        path: docs-artifacts


  deploy:
    if: ${{ github.ref == 'refs/heads/main' }}

    needs: build

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{steps.deployment.outputs.page_url}}

    runs-on: ubuntu-latest

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4