Repository navigation
226 lines (195 loc) · 8.15 KB
/
Copy pathdocs.yml
File metadata and controls
226 lines (195 loc) · 8.15 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
name: Docs Publish
on:
push:
branches: [main]
paths:
- docs/**
- src/**
- packages/mvtb-data/**
- pyproject.toml
- .github/workflows/docs.yml
pull_request:
branches: [main]
paths:
- docs/**
- src/**
- packages/mvtb-data/**
- pyproject.toml
- .github/workflows/docs.yml
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Only one deployment at a time; don't cancel an in-progress deploy
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-python@v7
with:
python-version: "3.12"
# the hooks of .pre-commit-config.yaml, from rvc-ecosystem: notebook outputs are
# cleared, the generated bootstrap cell is current, the first cell is well formed
- name: Check the notebooks
run: |
python -m pip install pre-commit
pre-commit run --all-files --show-diff-on-failure
- name: Install system dependencies
run: sudo apt-get install -y graphviz
- name: Install Python dependencies
run: |
pip install --upgrade pip
pip install -r docs/requirements.txt
cd packages/mvtb-data && pip install .
- name: Build docs
run: sphinx-build -b html docs/source docs/build/html
- name: Build wheel for JupyterLite
run: |
pip install build
python -m build --wheel --outdir docs/lite/pypi
- uses: actions/setup-node@v7
with:
node-version: "22"
cache: npm
cache-dependency-path: docs/lite/wasm_check/package-lock.json
- name: Check the JupyterLite install path actually works (real Pyodide, real WASM)
run: |
npm --prefix docs/lite/wasm_check ci
node docs/lite/wasm_check/check_pyodide_install.mjs docs/lite/pypi/*.whl
- name: Sync notebooks into JupyterLite content
run: |
mkdir -p docs/lite/files
find docs/notebooks \
-type f \
-name '*.ipynb' \
! -path '*/.ipynb_checkpoints/*' \
! -path '*/old/*' \
-print0 | while IFS= read -r -d '' nb; do
rel="${nb#docs/notebooks/}"
mkdir -p "docs/lite/files/$(dirname "$rel")"
cp -p "$nb" "docs/lite/files/$rel"
done
- name: Adapt staged notebooks for JupyterLite
run: |
python - <<'PY'
import json
from pathlib import Path
root = Path("docs/lite/files")
for nb_path in root.rglob("*.ipynb"):
with nb_path.open("r", encoding="utf-8") as f:
nb = json.load(f)
meta = nb.setdefault("metadata", {})
meta["kernelspec"] = {
"name": "python",
"display_name": "Python (Pyodide)",
"language": "python",
}
meta.setdefault("language_info", {})
meta["language_info"]["name"] = "python"
for cell in nb.get("cells", []):
if cell.get("cell_type") != "code":
continue
source = cell.get("source", [])
if isinstance(source, str):
lines = source.splitlines(keepends=True)
else:
lines = source
new_lines = []
changed = False
for line in lines:
if line.strip() in ("%matplotlib ipympl", "%matplotlib widget"):
newline = "\n" if line.endswith("\n") else ""
new_lines.append(f"%matplotlib inline{newline}")
changed = True
else:
new_lines.append(line)
if changed:
cell["source"] = (
new_lines
if not isinstance(source, str)
else "".join(new_lines)
)
with nb_path.open("w", encoding="utf-8") as f:
json.dump(nb, f, indent=1)
f.write("\n")
PY
- name: Build JupyterLite site
# jupyterlite-pyodide-kernel is a floor, not an exact pin. It was pinned to
# 0.6.1 (Pyodide 0.27.6) while Safari had no WebAssembly JSPI ("stack
# switching"), which newer Pyodide's run_until_complete() needs. Safari 27
# ships JSPI, and the old Pyodide then misbehaved there (the kernel never
# finished starting). A browser with no JSPI (Safari before 27; Firefox
# before 153) is now told so by a banner, added below, not supported by a pin.
# Installing jupyterlite-core directly rather than the jupyterlite metapackage.
# Keep docs/lite/wasm_check/package.json's pyodide in step with the Pyodide
# that the kernel bundles (0.8.7 bundles 314.0.6).
run: |
pip install jupyterlite-core "jupyterlite-pyodide-kernel>=0.8.7" jupyter-server
cd docs/lite && jupyter lite build --output-dir ../build/html/lite
- name: Add the browser capability check to JupyterLite
# a banner, before the kernel starts, if the browser has no WebAssembly JSPI
run: python docs/lite/inject_jspi_check.py docs/build/html/lite
# Real browsers, pre-deploy: gates publishing, so skipped for pull_request
# (which only builds). The Node/Pyodide check above covers dependency
# drift; this covers JupyterLab itself starting (before any kernel exists)
# and the kernel running the bootstrap cell, in Chromium and WebKit.
- name: Install browsers for the JupyterLite browser check
if: github.event_name != 'pull_request'
run: |
pip install playwright
playwright install --with-deps chromium webkit
- name: Check the built JupyterLite site starts in a real browser
if: github.event_name != 'pull_request'
# Informational until it has run green once on main (it is skipped for
# pull requests, so its first real CI run is on a publish). Then delete
# this line so a failure blocks the deploy.
continue-on-error: true
run: |
python -m http.server 8000 --directory docs/build/html &
sleep 3
python docs/lite/browser_check/check_lite_in_browser.py \
--base-url http://localhost:8000/lite \
--retries 1 --screenshot-dir browser-check-screenshots
- name: Upload browser-check screenshots
if: failure() && github.event_name != 'pull_request'
uses: actions/upload-artifact@v7
with:
name: lite-browser-check-screenshots
path: browser-check-screenshots
if-no-files-found: ignore
- name: Package notebooks zip
run: |
rm -f docs/build/html/mvtb_notebooks.zip
zip -r docs/build/html/mvtb_notebooks.zip docs/notebooks
- name: Upload notebooks zip artifact
uses: actions/upload-artifact@v7
with:
name: mvtb_notebooks
path: docs/build/html/mvtb_notebooks.zip
if-no-files-found: error
# push and workflow_dispatch both publish; pull_request only builds
# (to catch breakage in review), it never gets an artifact to deploy.
- uses: actions/upload-pages-artifact@v5
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
with:
path: docs/build/html
deploy:
needs: build
runs-on: ubuntu-latest
# ref check (not just event_name) so a manual dispatch from a
# non-main branch builds but doesn't publish -- push is already
# restricted to main via the `branches: [main]` filter above, but
# workflow_dispatch can be run against any branch.
if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5