{%- import 'python-versions.jinja' as py %}

# This workflow will install Python dependencies, build the package and then build the documentation.

name: Build documentation

on:

push:

branches: [ main ]

pull_request:

branches: [ main ]

permissions: {}

concurrency:

group: {% raw %}${{ github.workflow }}-${{ github.ref }}{% endraw %}

cancel-in-progress: true

jobs:

build:

runs-on: ubuntu-latest

permissions:

contents: read

steps:

- uses: actions/checkout@v7

with:

persist-credentials: false

- name: Set up Python {{ py.pref(python_versions) }}

uses: actions/setup-python@v7

with:

python-version: '{{ py.pref(python_versions) }}'

- name: Install uv

uses: astral-sh/setup-uv@v10.2.0

- name: Install dependencies

run: |

sudo apt-get update

uv pip install --system -e .

if [ -f docs/requirements.txt ]; then uv pip install --system -r docs/requirements.txt; fi

if [ -f requirements.txt ]; then uv pip install --system -r requirements.txt; fi

{%- if include_notebooks %}

- name: Install notebook requirements

run: |

sudo apt-get install pandoc

{%- endif %}

- name: Build docs

run: |

sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html