Migrate documentation from Jupyter Book v1 to MyST (v2) - #574
Open
mwouts wants to merge 2 commits into
Open
Conversation
- Move myst.yml into docs/ so that pages keep their previous URL structure
(apps/widget instead of docs/apps/widget)
- Add the pages that were dropped from the TOC: apps/panel,
options/col_reorder and options/show_df_type
- Create redirect stubs for the URLs of the Jupyter Book v1 site
('<path>.html', with underscores) and for the former rediraffe redirects
- Move notebook_metadata_filter from the notebook frontmatter to
docs/jupytext.toml, as MyST warns on that key ('jupytext' extra key
ignored); the filter excludes itself so jupytext --sync does not
write it back
- Remove the Jupyter Book v1 theme options (use_edit_page_button etc)
that do not exist in the MyST book theme
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FjUHgWXiMwHTBeVBMQiKWE
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #574 +/- ##
==========================================
- Coverage 94.28% 94.22% -0.07%
==========================================
Files 48 48
Lines 2748 2736 -12
==========================================
- Hits 2591 2578 -13
- Misses 157 158 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Thank you for making this pull request. Did you know? You can try it on Binder: Also, the version of ITables developed in this PR is available as a wheel artifact 📦 for easy installation. A conda package is also available for easy installation: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR migrates the ITables documentation from Jupyter Book v1 to MyST (Jupyter Book v2), updating the build configuration and tooling accordingly.
Key Changes
_config.ymland_toc.ymlwith a newmyst.ymlconfiguration file following MyST's formatdocs/create_redirects.pyto generate HTML redirect stubs for old documentation URLs, maintaining backward compatibility as MyST changes URL patterns (e.g., underscores to hyphens)docs/jupytext.tomlto centralize Jupytext settings and removed redundantnotebook_metadata_filterentries from individual document frontmatterpyproject.tomlto replacejupyter-book>=1with MyST dependenciesdocs/developing.mdanddocs/apps/streamlit.mdto reflect new build instructions2.8.2.dev0insrc/itables/version.pyImplementation Details
The migration maintains URL compatibility through the redirect script, which:
<path>.htmlURLs to MyST's<path>formatThe new MyST configuration consolidates project metadata and table of contents in a single YAML file, simplifying the documentation structure while maintaining the same content organization.
https://claude.ai/code/session_01FjUHgWXiMwHTBeVBMQiKWE