Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
name: Deploy Documentation
name: Deploy Documentation + Notebooks

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

# Sets permissions for GitHub Pages deployment
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
Expand All @@ -27,15 +24,15 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v6
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v6
uses: actions/setup-python@v5
with:
python-version: '3.14'
python-version: '3.12'

- name: Install uv
uses: astral-sh/setup-uv@v7
uses: astral-sh/setup-uv@v3

- name: Install dependencies
run: |
Expand All @@ -46,14 +43,29 @@ jobs:
sudo apt-get update
sudo apt-get install -y pandoc

- name: Build documentation
- name: Build Sphinx documentation
run: |
uv run sphinx-build -b html docs/source build/html

- name: Setup Quarto
uses: quarto-dev/quarto-actions/setup@v2

- name: Render Quarto notebooks
run: |
cd notebooks
quarto render

- name: Combine Sphinx + Notebooks
run: |
mkdir -p final_site
cp -r build/html/* final_site/
mkdir -p final_site/notebooks
cp -r notebooks/_site/* final_site/notebooks/

- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: build/html
path: final_site

deploy:
needs: build
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,8 @@ poetry.lock
.vscode/

benchmark_results/

example_files/
_site/
.quarto/
**/*.quarto_ipynb
5 changes: 5 additions & 0 deletions notebooks/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
project:
type: website

website:
title: "Example notebooks"
Loading