-
Notifications
You must be signed in to change notification settings - Fork 7
79 lines (62 loc) · 1.71 KB
/
deploy-docs.yml
File metadata and controls
79 lines (62 loc) · 1.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
name: Deploy Documentation + Notebooks
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.12'
- name: Install uv
uses: astral-sh/setup-uv@v7
- name: Install dependencies
run: |
uv sync --group docs
- name: Install Pandoc (required for nbsphinx)
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- 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: final_site
deploy:
needs: build
if: github.event_name == 'push' && ( github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs-website' )
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4