Migrate project to Jupyter Book 2.x with MyST engine#105
Migrate project to Jupyter Book 2.x with MyST engine#105Copilot wants to merge 7 commits intodependabot/pip/pip-dependencies-94ae0e35fdfrom
Conversation
…ith 5 updates Bumps the pip-dependencies group with 5 updates in the / directory: | Package | From | To | | --- | --- | --- | | [pytest-randomly](https://github.com/pytest-dev/pytest-randomly) | `3.16.0` | `4.0.1` | | [pytest-rerunfailures](https://github.com/pytest-dev/pytest-rerunfailures) | `15.1` | `16.1` | | [docutils](https://github.com/rtfd/recommonmark) | `0.21.2` | `0.22.4` | | [jupyter-book](https://github.com/jupyter-book/jupyter-book) | `1.0.4.post1` | `2.1.0` | | [sphinx](https://github.com/sphinx-doc/sphinx) | `7.4.7` | `8.1.3` | Updates `pytest-randomly` from 3.16.0 to 4.0.1 - [Changelog](https://github.com/pytest-dev/pytest-randomly/blob/main/CHANGELOG.rst) - [Commits](pytest-dev/pytest-randomly@3.16.0...4.0.1) Updates `pytest-rerunfailures` from 15.1 to 16.1 - [Changelog](https://github.com/pytest-dev/pytest-rerunfailures/blob/master/CHANGES.rst) - [Commits](pytest-dev/pytest-rerunfailures@15.1...16.1) Updates `docutils` from 0.21.2 to 0.22.4 - [Changelog](https://github.com/readthedocs/recommonmark/blob/master/CHANGELOG.md) - [Commits](https://github.com/rtfd/recommonmark/commits) Updates `jupyter-book` from 1.0.4.post1 to 2.1.0 - [Release notes](https://github.com/jupyter-book/jupyter-book/releases) - [Commits](jupyter-book/jupyter-book@v1.0.4.post1...v2.1.0) Updates `sphinx` from 7.4.7 to 8.1.3 - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/v8.1.3/CHANGES.rst) - [Commits](sphinx-doc/sphinx@v7.4.7...v8.1.3) --- updated-dependencies: - dependency-name: pytest-randomly dependency-version: 4.0.1 dependency-type: direct:development update-type: version-update:semver-major dependency-group: pip-dependencies - dependency-name: pytest-rerunfailures dependency-version: '16.1' dependency-type: direct:development update-type: version-update:semver-major dependency-group: pip-dependencies - dependency-name: docutils dependency-version: 0.22.4 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: pip-dependencies - dependency-name: jupyter-book dependency-version: 2.1.0 dependency-type: direct:development update-type: version-update:semver-major dependency-group: pip-dependencies - dependency-name: sphinx dependency-version: 8.1.3 dependency-type: direct:development update-type: version-update:semver-major dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: fschuch <37457501+fschuch@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
|
@copilot Migrate the project to |
Co-authored-by: fschuch <37457501+fschuch@users.noreply.github.com>
Co-authored-by: fschuch <37457501+fschuch@users.noreply.github.com>
Co-authored-by: fschuch <37457501+fschuch@users.noreply.github.com>
|
Migration to Jupyter Book 2.x completed in commits 1daa998, 3e5523d, b8a54fc, and a76aa60. Key changes:
Limitations documented in MIGRATION.md:
The migration maintains all core functionality while moving to the modern MyST architecture. See MIGRATION.md for complete details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
789f06e to
5e68f18
Compare
|
Jupyter Book 2.x breaks compatibility with some Sphinx plugins this project relies on, like auto docstings and change log builder from GitHub releases, so lets not implement it just yet. @copilot create an issue so we at least keep track of this topic. |



Completes the migration from Jupyter Book 1.x (Sphinx-based) to Jupyter Book 2.x (MyST engine-based) as part of the dependency update from dependabot.
Migration Overview
This PR migrates the documentation system from the legacy Sphinx-based Jupyter Book 1.x to the modern MyST-based Jupyter Book 2.x architecture.
Changes Made
Configuration Migration
jupyter-book init) to convert_config.ymland_toc.ymlto unifiedmyst.yml._config.yml.bakand._toc.yml.bakDependency Updates
jupyter-book==2.1.2(MyST-based)docutils,sphinx,sphinx-autobuild,sphinx-github-changelogSyntax Compatibility Fixes
centered,changelog):link-type:,:class-header:,:gutter:)api-reference.rsttoapi-reference.md(MyST doesn't support RST).bibfiles not supported)Build System Updates
pyproject.tomlto use native MyST commandsjupyter-book config sphinx→jupyter-book buildbuild/htmlinstead ofbuild/_build/html)SPHINX_GITHUB_CHANGELOG_TOKENenvironment variable (no longer needed)Documentation
MIGRATION.mddocumenting all changes, limitations, and benefitsKnown Limitations
Jupyter Book 2.x with MyST engine does not support:
sphinx-github-changelogfor automated release notes).bibformat)These limitations are fully documented in
MIGRATION.mdwith explanations and workarounds where applicable.Benefits
myst.ymlfile instead of multiple config files💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.