-
-
Notifications
You must be signed in to change notification settings - Fork 3
ENH: Migrate to use mystmd and quantecon-theme.
#31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for beautiful-dodol-cb9543 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hi @mmcky , I have updated the lectures and added some final touch ups. Removed the following lectures which don't work:
Also, there are few known theme specific errors which we can work on gradually while we move all the lecture series to mystmd theme. |
|
One of the examples of cross reference failures is in https://68ef1da543d00816def83173--beautiful-dodol-cb9543.netlify.app/long-run-growth/. Ref name Coming from: |
|
@kp992 we can actually solve this by updating the syntax to be compatible with the new https://mystmd.org/guide/reuse-jupyter-outputs#outputs-as-figures |
|
Thanks @mmcky, I will look into it and update the lectures |
|
thanks @kp992 are you happy for me to merge this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR migrates the project from Jupyter Book to MyST Markdown (mystmd) with the quantecon-theme, representing a significant infrastructure change in the documentation build system.
Key Changes:
- Migration from Jupyter Book/TeachBooks to MyST Markdown build system
- Conversion of figure references from Jupyter Book syntax to MyST syntax
- Replacement of solution/exercise directive syntax to match MyST format
- Update of CI/CD workflow to use
mystmdCLI instead of TeachBooks
Reviewed Changes
Copilot reviewed 46 out of 120 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
update_lectures.py |
Adds preprocessing logic for converting solution/exercise directives and changes output directory |
lectures/myst.yml |
New MyST configuration file defining project metadata, table of contents, and theme |
book/*.md (multiple) |
Convert figure syntax from Jupyter Book to MyST format with :label: and :::{figure} blocks |
book/*.md (multiple) |
Replace {solution-start}/{solution-end} and {exercise-start}/{exercise-end} with {solution} directives |
book/_toc.yml |
Removed Jupyter Book table of contents configuration |
book/_config.yml |
Removed Jupyter Book configuration file |
.github/workflows/ci_pr.yml |
Updated CI workflow to use MyST Markdown CLI for building |
Comments suppressed due to low confidence (2)
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Sure @mmcky. It looks good to go |
|
📖 Netlify Preview Ready! Preview URL: https://pr-31--beautiful-dodol-cb9543.netlify.app (8779539) ✨ Browse the preview at the URL above. |
- Add PR event types (opened, synchronize, reopened) - Remove branch restrictions on pull_request to work for all PRs - Add workflow_dispatch input for preview_page - Add --context flags to Netlify deploy (pr-preview, dev) - Add manual preview page support in PR comments
|
📖 Netlify Preview Ready! Preview URL: https://pr-31--beautiful-dodol-cb9543.netlify.app (0087035) ✨ Browse the preview at the URL above. |
The project migrated from teachbooks/jupyter-book to mystmd in October 2025 (PR #31). This commit corrects all documentation to reflect the current build system. Changes: - Update all build commands from teachbooks to mystmd - Fix README.md installation and build instructions - Update docs/CONTRIBUTING.md with correct development workflow - Update docs/ARCHITECTURE.md build system documentation - Update docs/QUICK_REFERENCE.md with mystmd commands - Update .github/copilot-instructions.md - Mark requirements.txt as deprecated (Node.js deps only now) The correct build process is now: npm install -g mystmd thebe-core thebe thebe-lite cd lectures myst build --html myst start Note: requirements.txt contains legacy teachbooks dependencies and is not used in the current mystmd build process.
This PR sets up the project to use the latest
mystmdand quantecon theme.