Skip to content

Move to jupyter-book 2 - #332

Draft
ocefpaf wants to merge 4 commits into
ioos:mainfrom
ocefpaf:jb2
Draft

Move to jupyter-book 2#332
ocefpaf wants to merge 4 commits into
ioos:mainfrom
ocefpaf:jb2

Conversation

@ocefpaf

@ocefpaf ocefpaf commented Jul 10, 2026

Copy link
Copy Markdown
Member

Let's list the issues we find here so we can try to address them later:

  • The nb-gallery does not work;
  • project/exclude files doesn't skip the archived notebooks;
  • Page iframes are rendered as single pages;
  • Run on external computing interface is broken. We need to restore the options for binder and google notebooks;
  • Remove the thebe kernel button;
  • Fix duplicated title
  • Do we need "Other Resources"?
  • The Logo is in an odd position in the new theme.

Closes #331

NB: We cannot use the ioos_header in Jupyterbook 2. It is quite hard to override all new JS unless they provide a proper way to specify it.

The site is rendered at: https://ocefpaf.github.io/ioos_code_lab/

@ocefpaf

ocefpaf commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

@MathewBiddle I can build the pages now and I'm listing the issues I can see so far above and trying to assess if we can fix them in our workflow or if we need to reach out to the Jupyter book maintainers.

One issue that I don't think we will be able to fix is the new IOOS header. JB2 is quite complex in its HTML build and overriding it to add our JS header doesn't go well with JB2 code.

Another one that will be very challenging is the gallery navigation. JB2 doesn't take the sphinx directives anymore and I'm not sure if there is a workaround.

@MathewBiddle

Copy link
Copy Markdown
Contributor

If this becomes too hard to migrate, we don't need to do it. We just need to define what the breakpoint is.

@ocefpaf

ocefpaf commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

If this becomes too hard to migrate, we don't need to do it. We just need to define what the breakpoint is.

There are no real advantages to upgrade at the moment, but I'll keep working on the issues to see how far we can get.

We will need to upgrade the day they stop maintaining JB1 and we have an unpatchable security issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate to JupyterBook 2

2 participants