Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to JupyterBook 2.0 with MyST #115

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Upgrade to JupyterBook 2.0 with MyST #115

wants to merge 10 commits into from

Conversation

tsnow03
Copy link
Member

@tsnow03 tsnow03 commented Jan 30, 2025

Upgrading to JupyterBook 2.0a so we have the added MyST features. This JupyterBook builds on my local computer and the environment is good to go. It won't build here yet though. I also think some features are missing at the moment because I'm not sure if I've gotten all of the important features into it from the old jupyterbook _config.yml file or if they aren't available yet in the v2.0.0a0 version. Small changes will need to be made to the notebooks and md files, which I haven't done yet.

To Do:

  • Fix the build: scripts/build_resources.sh is using an outdated version of JupyterBook? may also need to update .github/actions/buildresources
  • Ensure all old _config.yml configurations are added to the new myst.yml if it is possible
  • Check and update all markdown and notebooks if anything is broken
  • [Optional] Can we get the toc into myst.yml? I wasn't able to get it to work so it currently functions using _toc.yml, but the draft I've created is in there
  • [Optional] Do we need all of the myst libraries that have been added into this environment.yml? What I have may be overkill, but I know we need mystmd.

Copy link

Binder 👈 Launch a binder notebook on this branch

@tsnow03
Copy link
Member Author

tsnow03 commented Jan 30, 2025

Useful resources
JupyterBook 2.0a realease blog: https://blog.jupyterbook.org/posts/2024-11-15-jupyter-book-2-alpha
example full scale jupyterbook repo: https://github.com/jupyter-book/mystmd/blob/main/docs/myst.yml
JupyterBook documentation: https://next.jupyterbook.org/tutorial/website

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant