refactor: migrate from Jupyter Book to MyST MD#99
Merged
Conversation
Replace jupyter-book with mystmd for building the course site. - Create myst.yml consolidating _config.yml and _toc.yml into the MyST MD native configuration format - Update pixi.toml: swap jupyter-book/sphinxcontrib-mermaid for mystmd, change build commands to myst build --execute --html - Update environment.yml to match pixi.toml dependency changes - Remove _config.yml and _toc.yml (replaced by myst.yml) - Remove noxfile.py book session (building now via pixi only) - Update cd.yml artifact name from jupyterbook to myst-site - Update AGENTS.md to reflect new tooling and config Assisted-by: OpenCode:glm-5
henryiii
force-pushed
the
henryiii/refactor/mystmd
branch
from
9bc5ed2 to
d939f6e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I also hand fixed the build warnings, mostly already there before this upgrade.
🤖 Human guided, AI assisted PR (using this skill). AI text below. 🤖
Summary
Replace jupyter-book with mystmd for building the course site, modernizing to the native MyST MD toolchain.
Changes
myst.yml(new) — Consolidates_config.ymland_toc.ymlinto the MyST MD native configuration format, including project metadata, TOC (converted from JBparts/chaptersto MySTtitle/children), exclude patterns, and site actions.pixi.toml— Swappedjupyter-bookandsphinxcontrib-mermaidformystmd; updated build tasks tomyst build --execute --htmlandmyst build --execute --pdf.environment.yml— Same dependency changes as pixi.toml.noxfile.py— Removed thebooksession (building is now exclusively via pixi)..github/workflows/cd.yml— Renamed artifact fromjupyterbooktomyst-site.AGENTS.md— Updated to reflect mystmd tooling andmyst.ymlconfig references._config.ymland_toc.yml(replaced bymyst.yml).Assisted-by: OpenCode:glm-5