-
-
Notifications
You must be signed in to change notification settings - Fork 25
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Background
As part of the QuantEcon Actions migration (see QuantEcon/actions#25 and PLAN.md), we're simplifying our notebook deployment architecture.
Current design:
- Lecture repos (e.g.,
lecture-python.myst) build notebooks viasphinx-tojupyter - Notebooks are synced to separate
.notebooksrepos (e.g.,lecture-python.notebooks) - Colab badges link to:
https://colab.research.google.com/github/QuantEcon/{repo}.notebooks/blob/main/{path}
New design:
- Notebooks are deployed to gh-pages alongside HTML content in
_notebooks/directory - Colab badges link to:
https://colab.research.google.com/notebook?url=https://{domain}/_notebooks/{path} - Eliminates 4 separate
.notebooksrepos and sync workflows
Requested Changes
Update Colab badge/link generation to support notebooks hosted on gh-pages:
Current URL format:
https://colab.research.google.com/github/QuantEcon/lecture-python.notebooks/blob/main/example.ipynb
New URL format:
https://colab.research.google.com/notebook?url=https://python.quantecon.org/_notebooks/example.ipynb
Implementation Notes
- Google Colab supports opening notebooks from any public URL via the
urlparameter - The
{domain}should be configurable per lecture series:lecture-python.myst→python.quantecon.orglecture-python-programming.myst→python-programming.quantecon.orglecture-python-intro→ (Netlify domain)lecture-python-advanced.myst→python-advanced.quantecon.org
- Notebooks are already copied to
_build/html/_notebooks/via thebuild-lecturesaction withhtml-copy-notebooks: 'true'
Benefits
- ✅ Reduces repo count from 8 to 4 (eliminates
.notebooksrepos) - ✅ Eliminates sync step in publish workflows
- ✅ Single source of truth for notebooks
- ✅ Simpler maintenance
Related
- QuantEcon/actions PLAN.md — Migration strategy
- QuantEcon/actions PR #25 — ML libs removal
- Primary user access: (1) Download links on lecture pages, (2) Colab badges on lecture pages
Timeline
Needed for upcoming lecture repository migrations (Q1 2026).
cc @mmcky
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request