-
Notifications
You must be signed in to change notification settings - Fork 49
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 Jupyter Books in myst init
#1223
base: main
Are you sure you want to change the base?
Conversation
Should we really begin phase out |
@stevejpurves I agree. My suggestion is that we evaluate |
@agoose77 if the goal is to use this to learn about
That way you can structure the information gathering rather than have it as a one-off tool that might confuse us in N months when we've forgotten about this conversation |
ef1029a
to
e7728be
Compare
One more recommendation here (or in a follow up pr if it's out of scope) If we detect a config.yml file, I assume we want to note the upgrade command. But for a while, I think we should also note that people can run the v1 version of jupyter book by installing the version ==1. Alternatively what do you think about making a pypi package like jupyter-book-sphinx and pinning that to the 1.x series (similar to nbclassic) |
8e75818
to
271aa46
Compare
I tried this on CMIP6:
|
1bc82c1
to
58894c2
Compare
@fwkoch your thoughts on this would be welcome. I've decided that instead of a
I tested the WIP on The Turing Way, and it seems to handle it fairly well. |
The line between "upgrading" a JB and upgrading MyST syntax is a little blurry. My take is that the JB upgrade is special, and we should treat it as such -- users will have an "old" project with known legacy aspects, vs users with one year old MyST projects that use some slightly deprecated syntax. |
upgrade
command for Jupyter Booksmyst init
I need some help setting up unit tests for this (I am hoping someone else will make my life easier...)! |
With the goal of running Jupyter Book on top of MyST, we need the ability to upgrade a book's configuration and TOC to
myst.yml
.This PR adds a Jupyter-Book upgrade path when:
myst init
is invoked andmyst.yml
and_config.yml
.This PR depends upon #1188.
I've introduced
zod
for this PR, with the intention that we'll slowly phase outsimple-validators
. There's a challenge with lazy inference and circular references detailed here: colinhacks/zod#3510myst.yml