Consider updating to Jupyterbook 2 / MystMD

Open
#362 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
jupyter-notebook

Research direction

Start with the JupyterBook 1 maintenance FAQ and the pinned dependency at pyproject.toml line 74. Scope the migration to JupyterBook >=2, including the stated removal of Sphinx and adoption of MyST. Done means the repository’s tutorial build works with the new toolchain.

Written by the indexing model from the issue text.

Description

help wanted

This repository currently pins jupyterbook<2 which is now in maintenance mode and will probably become increasingly harder to update
https://github.com/xarray-contrib/xarray-tutorial/blob/2ac823ee3f29db4e95726df3c568d8e11bb46396/pyproject.toml#L74

https://jupyterbook.org/stable/resources/faq/#will-jupyter-book-1-continue-to-be-maintained

But updating to JupyterBook>=2 would take some time, drop sphinx, and start using myst...

Dominant language
Jupyter Notebook
Stars
204
Forks
121
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/xarray-tutorial

All issues in xarray-contrib/xarray-tutorial

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.