Skip to content

Upgrade docs pipeline to Jupyter Book v2#150

Merged
AadilLatif merged 1 commit intomainfrom
feature/jupyter-book-v2-upgrade
Mar 6, 2026
Merged

Upgrade docs pipeline to Jupyter Book v2#150
AadilLatif merged 1 commit intomainfrom
feature/jupyter-book-v2-upgrade

Conversation

@AadilLatif
Copy link
Collaborator

@AadilLatif AadilLatif commented Mar 6, 2026

Summary

  • upgrade docs dependency to jupyter-book>=2,<3
  • migrate docs config from legacy _config.yml/_toc.yml to docs/myst.yml
  • update deploy workflow to use Jupyter Book v2 commands
  • replace legacy toctree directive blocks in API and CLI index pages

Validation

  • built docs locally with Jupyter Book v2 from docs/
  • build command: jupyter-book build --html

Notes

  • workflow currently sets NODE_TLS_REJECT_UNAUTHORIZED=0 in build step due upstream api.mystmd.org certificate issue observed during v2 template fetch

- Add jupyter-book>=2,<3 to doc dependencies
- Migrate docs config from _config.yml/_toc.yml to myst.yml
- Update deploy workflow to use v2 build commands
- Replace legacy toctree blocks in API/CLI index pages
@AadilLatif AadilLatif merged commit 86210c9 into main Mar 6, 2026
4 checks passed
@AadilLatif AadilLatif deleted the feature/jupyter-book-v2-upgrade branch March 6, 2026 16:36
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.

1 participant