This pins myst-nb to 0.16 and fixes tests.

Note that it does not yet

• Update the documentation to reflect the breaking changes
• Update the documentation to reflect the new additions/features

As described in https://github.com/executablebooks/jupyter-book/issues/1819

Aug 30 '22 22:08 cadr

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

Aug 30 '22 22:08 welcome[bot]

Heya thanks, this is certainly a step in the right direction.

As you mention, there are still things to be done, such as documentation. But also I would note, one would ideally like to provide a CLI command, to auto-convert peoples current _config.yml to the new format (such as changing the key values)

Then also, really the whole config format is, IMO, not particularly great, and horrible to upgrade/understand, and I would like to change it, in-line with #1728.

These considerations have really just hindered me from ever actually completing this task myself. So yeh, there probably does need to be a compromise in maybe doing this "simpler" way first, then reorganising the config 🤷‍♂️

Aug 30 '22 22:08 chrisjsewell

As you mention, there are still things to be done, such as documentation. But also I would note, one would ideally like to provide a CLI command, to auto-convert peoples current _config.yml to the new format (such as changing the key values)

To be clear, is it just the the name of the six keys that changed that you are talking about? Not sure if having an auto-convert for "nb_mime_priority_overrides" makes sense, but I could be missing something.

Also, do you know why the 'readthedocs" build failed?

Aug 30 '22 22:08 cadr

Also, do you know why the 'readthedocs" build failed?

Yeh, you can see the WARNING in the build log, that need to be fixed: https://readthedocs.org/projects/jupyter-book/builds/17941575/

Aug 30 '22 22:08 chrisjsewell

To be clear, is it just the the name of the six keys that changed that you are talking about?

well, for instance, there is also config options that have been added, which should also be reflected in the JB config:

• https://myst-parser.readthedocs.io/en/latest/configuration.html
• https://myst-nb.readthedocs.io/en/latest/configuration.html

Aug 30 '22 22:08 chrisjsewell

well, for instance, there is also config options that have been added, which should also be reflected in the JB config

but maybe we can delay adding these until later

Aug 30 '22 22:08 chrisjsewell

Yeh, you can see the WARNING in the build log

Oh, haha. I was confused because I didn't change anything about the docs, but I guess this upgraded other things that the doc generation uses.

Aug 30 '22 23:08 cadr

but I guess this upgraded other things that the doc generation uses.

Oh yes indeed; myst-nb (built on myst-parser, which this will also update) is basically one of the main parts of jupyter book document generation, and going from v0.14 to v0.16, is certainly not just a cosmetic change 😅

Aug 30 '22 23:08 chrisjsewell

thanks @cadr for kicking this off. Thanks @chrisjsewell for your expert knowledge in this upgrade. It was great to discuss this on the team meeting today and get a better understanding of what needs to be done. We will take a look at sphinx-jupyterbook-latex (cc @AakashGfude) and make that compatible with myst-parser and myst-nb while maintaining backward compatibility.

Sep 01 '22 00:09 mmcky

Codecov Report

Base: 91.39% // Head: 91.39% // No change to project coverage :thumbsup:

Coverage data is based on head (311c820) compared to base (5e5f629). Patch coverage: 50.00% of modified lines in pull request are covered.

@@           Coverage Diff           @@
##           master    #1825   +/-   ##
=======================================
  Coverage   91.39%   91.39%           
=======================================
  Files           7        7           
  Lines         686      686           
=======================================
  Hits          627      627           
  Misses         59       59           

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

Sep 21 '22 05:09 codecov[bot]

Updated sphinx-jupyterbook-latex==0.5.0 but it looks like we need to fix a number of deprecations

Sep 21 '22 05:09 mmcky

@AakashGfude I have moved this work over to a local branch #1842

Sep 28 '22 04:09 mmcky

@AakashGfude I have moved this work over to a local branch #1842

ooh yup. thanks

Sep 28 '22 04:09 AakashGfude

Closing in favor of https://github.com/executablebooks/jupyter-book/pull/1842

Nov 02 '22 21:11 cadr