Skip to content

[Experimental] Use jupyter-book 2.0 for building the lectures #1483

[Experimental] Use jupyter-book 2.0 for building the lectures

[Experimental] Use jupyter-book 2.0 for building the lectures #1483

Workflow file for this run

name: Build Project [using jupyter-book]
on: [pull_request]
jobs:
preview:
runs-on: "runs-on=${{ github.run_id }}/family=g4dn.2xlarge/image=quantecon_ubuntu2404/disk=large"
steps:
- uses: actions/checkout@v6
- name: Setup GitHub Pages
uses: actions/configure-pages@v3
- name: Cache Notebook Execution
uses: actions/cache@v3
id: cache-execution
with:
path: ./lectures/_build/execute
key: ${{ runner.os }}-execute-cache-${{ hashFiles('lectures/**/*.md') }}
- uses: actions/setup-node@v4
with:
node-version: '20'
- uses: oven-sh/setup-bun@v2
- name: Install Python
if: steps.cache-execution.outputs.cache-hit != 'true'
uses: actions/setup-python@v5
with:
python-version: '3.12'
cache: 'pip'
cache-dependency-path: 'myst_requirements.txt'
- name: Install execution requirements
if: steps.cache-execution.outputs.cache-hit != 'true'
run: python -m pip install -r myst_requirements.txt
- name: Install jupyter book 2.0
run: pip install "jupyter-book>=2.0.0a0"
- name: Install mystmd (QuantEcon fork)
run: |
git clone --branch quantecon --depth 1 \
https://github.com/QuantEcon/mystmd.git /tmp/qe-mystmd
cd /tmp/qe-mystmd
bun install
bun run build
npm install -g /tmp/qe-mystmd/packages/mystmd
- name: Verify mystmd version
run: myst --version
- name: Build HTML
working-directory: ./lectures
run: jupyter book build --html --execute
- name: Upload build output
uses: actions/upload-artifact@v6
with:
path: './lectures/_build/html'
- name: Preview Deploy to Netlify
uses: nwtgck/actions-netlify@v3
with:
publish-dir: './lectures/_build/html'
production-branch: main
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: "Preview Deploy from GitHub Actions"
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}