Skip to content

Conversation

@brian-rose
Copy link
Member

This PR migrates the cookbook-template repo to use MyST.

It should serve as a useful example of how to remove unnecessary cruft from the repo and update the workflows.

kafitzgerald and others added 30 commits July 13, 2024 15:25
…template

Update notebook template with MyST syntax
Merge in recent updates the main Template repo
Use myst build command for PRs
@github-actions
Copy link

github-actions bot commented Jun 17, 2025

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: a562d90
✅ Deployment Preview URL: In Progress

@brian-rose brian-rose marked this pull request as ready for review June 17, 2025 21:12
@r-ford r-ford self-requested a review June 17, 2025 21:15
Copy link
Contributor

@jukent jukent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Co-authored-by: Katelyn FitzGerald <[email protected]>
@ktyle
Copy link
Contributor

ktyle commented Jun 17, 2025

minor typo in myst.yml: in the title: line, change Jupter to Jupyter

myst.yml Outdated
extends:
- https://raw.githubusercontent.com/projectpythia/pythia-config/main/pythia.yml
project:
title: Project Pythia Cookbook Template - Jupter Book 2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As Kevin mentioned.

Suggested change
title: Project Pythia Cookbook Template - Jupter Book 2
title: Project Pythia Cookbook Template - Jupyter Book 2

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, but I think it might be better to just remove this, since it will be the template going forward.

Co-authored-by: Katelyn FitzGerald <[email protected]>
@brian-rose
Copy link
Member Author

I'm going to make a change to the notebook template to resolve projectpythia-mystmd#41

@brian-rose brian-rose merged commit f3803cb into ProjectPythia:main Jun 17, 2025
2 of 3 checks passed
@brian-rose brian-rose deleted the simplify branch June 17, 2025 22:12
myst.yml Outdated
title: Project Pythia Cookbook Template - Jupter Book 2
github: https://github.com/projectpythia/cookbook-template
thumbnail: thumbnails/thumbnail.png
tags: ["sampletag"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tags: ["sampletag"]

myst.yml Outdated
project:
title: Project Pythia Cookbook Template - Jupter Book 2
github: https://github.com/projectpythia/cookbook-template
thumbnail: thumbnails/thumbnail.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
thumbnail: thumbnails/thumbnail.png

myst.yml Outdated
github: https://github.com/projectpythia/cookbook-template
thumbnail: thumbnails/thumbnail.png
tags: ["sampletag"]
keywords: ["samplekeyword"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
keywords: ["samplekeyword"]

github-actions bot pushed a commit that referenced this pull request Jun 17, 2025
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.

6 participants