Fix Jupyter Book deployment to GitHub Pages #194
Merged
Conversation
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
- Add docs.yaml workflow to build and deploy Jupyter Book using myst build - Fix branch reference in _config.yml from master to main - Configure GitHub Pages deployment with proper permissions Fixes #193 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Migrated from Jupyter Book 1.x to 2.0 using MyST - Created myst.yml config (migrated from _config.yml and _toc.yml) - Updated workflow to install JB2.0 and run upgrade process - Old config files backed up as ._config.yml.bak and ._toc.yml.bak - Build command now: jupyter book build --html 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Use myst build --html instead of jupyter book build - Set BASE_URL=/policyengine-uk-data for correct GitHub Pages paths - Create .nojekyll file in build output - Deploy to gh-pages branch using JamesIves/github-pages-deploy-action - Fix author name format in myst.yml to avoid warnings - Matches working policyengine-us-data deployment pattern 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
mastertomainChanges
docs/myst.yml: New MyST-based configuration (migrated from_config.ymland_toc.yml)docs/._config.yml.bak,docs/._toc.yml.bak: Backup of old config files.github/workflows/docs.yaml: New workflow to build docs with JB2.0 and deploy to GitHub Pageschangelog_entry.yaml: Added changelog entryKey Upgrade Details
Jupyter Book 2.0 is a complete rewrite using MyST (Markedly Structured Text):
myst.ymlinstead of_config.yml+_toc.ymljupyter book build --htmlTest plan
Note
This PR is in draft until CI passes. After the upgrade completes successfully, GitHub Pages needs to be configured to use "GitHub Actions" as the build source (Settings → Pages → Build and deployment → Source: GitHub Actions).
Fixes #193
🤖 Generated with Claude Code