Skip to content

Conversation

@mmcky
Copy link
Contributor

@mmcky mmcky commented Sep 29, 2025

This PR sets up the project to use the latest mystmd and quantecon theme.

@netlify
Copy link

netlify bot commented Sep 29, 2025

Deploy Preview for beautiful-dodol-cb9543 ready!

Name Link
🔨 Latest commit 0087035
🔍 Latest deploy log https://app.netlify.com/projects/beautiful-dodol-cb9543/deploys/68f86b5bb59be5000861a914
😎 Deploy Preview https://deploy-preview-31--beautiful-dodol-cb9543.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kp992
Copy link
Collaborator

kp992 commented Oct 15, 2025

Hi @mmcky , I have updated the lectures and added some final touch ups. Removed the following lectures which don't work:

  • business_cycle
  • inequality
  • prob-dist
  • heavy-tails
  • commod-price
  • lp-intro
  • short_path
  • input-output

Also, there are few known theme specific errors which we can work on gradually while we move all the lecture series to mystmd theme.

@kp992
Copy link
Collaborator

kp992 commented Oct 16, 2025

One of the examples of cross reference failures is in https://68ef1da543d00816def83173--beautiful-dodol-cb9543.netlify.app/long-run-growth/. Ref name gdp1 and gdp2.

Coming from:

---
mystnb:
  figure:
    caption: GDP in the early industrialization era
    name: gdp1
---

@mmcky
Copy link
Contributor Author

mmcky commented Oct 17, 2025

@kp992 we can actually solve this by updating the syntax to be compatible with the new mystnb system. I think the way it works is you generate a figure in code with a label and then use a figure directive to reference that label to fetch the object. That kind of makes sense to me -- rather than duplicate figure handling logic.

https://mystmd.org/guide/reuse-jupyter-outputs#outputs-as-figures

@kp992
Copy link
Collaborator

kp992 commented Oct 17, 2025

Thanks @mmcky, I will look into it and update the lectures

@mmcky
Copy link
Contributor Author

mmcky commented Oct 20, 2025

thanks @kp992 are you happy for me to merge this?

@mmcky mmcky requested a review from Copilot October 20, 2025 00:25
Copy link

Copilot AI left a 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 mystmd CLI 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.

@kp992
Copy link
Collaborator

kp992 commented Oct 20, 2025

Sure @mmcky. It looks good to go

@github-actions
Copy link

📖 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
@github-actions
Copy link

📖 Netlify Preview Ready!

Preview URL: https://pr-31--beautiful-dodol-cb9543.netlify.app (0087035)

✨ Browse the preview at the URL above.

@mmcky mmcky merged commit 080d7b3 into main Oct 23, 2025
6 checks passed
@mmcky mmcky deleted the theme_updates branch October 23, 2025 00:38
mmcky added a commit that referenced this pull request Nov 1, 2025
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.
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.

3 participants