Skip to content

Migrate to Jupyter Book 2#85

Merged
junpenglao merged 4 commits intomainfrom
jb2-migration
Apr 3, 2026
Merged

Migrate to Jupyter Book 2#85
junpenglao merged 4 commits intomainfrom
jb2-migration

Conversation

@junpenglao
Copy link
Copy Markdown
Member

Summary

  • Upgrade jupyter-book from 1.x to >=2 (now backed by the MyST document engine)
  • Replace _config.yml + _toc.yml with unified myst.yml
  • Update CI workflows to use jupyter book build --execute --html with BASE_URL for GitHub Pages
  • Add BlackJAX logo and site branding ("The Sampling Book" title + GitHub link in nav)
  • Update README with setup, build, jupytext conversion, and contributing instructions
  • Add CLAUDE.md for Claude Code guidance

Test plan

  • jupyter book start --execute renders all 22 pages correctly with notebook outputs
  • Only 2 pre-existing citation warnings in hierarchical_bnn.md (@karalleyna, @murphyk GitHub handles misread as citations)
  • Verify CI build passes on this PR
  • Verify GitHub Pages deployment after merge

🤖 Generated with Claude Code

junpenglao and others added 4 commits April 2, 2026 21:36
- Upgrade jupyter-book from 1.x to >=2 (backed by mystmd engine)
- Replace _config.yml + _toc.yml with unified myst.yml
- Update CI workflows: use `jupyter book build --execute --html`
- Add BASE_URL env var for GitHub Pages deployment
- Add BlackJAX logo and site branding
- Update README with build/setup/contributing instructions
- Add CLAUDE.md for Claude Code guidance

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add execute config to myst.yml so notebook outputs are cached
in _build/execute/ and reused when cell code hasn't changed.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Move logo under site.options in myst.yml
- Remove unsupported execute config (use --execute CLI flag instead)
- Change :args: to :tags: in mlp.md
- Convert @-mentions to links in hierarchical_bnn.md to avoid citation errors

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@junpenglao junpenglao merged commit b496325 into main Apr 3, 2026
1 check passed
@junpenglao junpenglao deleted the jb2-migration branch April 3, 2026 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant