Skip to content
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

📓 Add ipynb as export format #1882

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

📓 Add ipynb as export format #1882

wants to merge 1 commit into from

Conversation

rowanc1
Copy link
Member

@rowanc1 rowanc1 commented Feb 28, 2025

cc @mmcky

Copy link

changeset-bot bot commented Feb 28, 2025

🦋 Changeset detected

Latest commit: 7c1aa47

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
myst-frontmatter Patch
myst-to-ipynb Patch
myst-cli Patch
myst-common Patch
myst-config Patch
myst-spec-ext Patch
myst-to-md Patch
mystmd Patch
myst-migrate Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@mmcky
Copy link
Contributor

mmcky commented Feb 28, 2025

thanks @rowanc1. I will check this branch out and give it a go tomorrow.

@choldgraf
Copy link
Collaborator

choldgraf commented Feb 28, 2025

This would be really useful for educational use cases in general. It's something many people have requested! Especially if:

  1. it is possible for some cells to not show up in the output notebooks.
  2. If launch buttons etc can launch the built notebooks instead of the source notebooks.

I don't think either of those should block this, just noting commonly requested functionality if it is helpful. People often want this to separate teacher and student copies of things.

I bet there is an issue in jupyter book we can link this against. (On phone now so it is hard to look)

@mmcky
Copy link
Contributor

mmcky commented Feb 28, 2025

agree @choldgraf. Some form of state based code-cells (enabling student and teacher (solution) notebook versions) is a super useful feature for education. I'll search through the issues and/or open one to track this use case.

@kp992
Copy link

kp992 commented Mar 8, 2025

Thanks for the putting this together. I am happy to help in completing this feature.

@choldgraf
Copy link
Collaborator

Just noting there was some discussion on the jupyter-education listserv today of folks asking whether it was possible to generate notebooks from "teacher copies" which reminded me of this feature.

@nthiery
Copy link
Contributor

nthiery commented Mar 8, 2025

Is one of the use case in mind to regenerate the notebook in a book with cross links resolved and the like? That would be quite useful indeed!

With that in mind, I would suggest to also enable -- in this PR or a followup -- exporting text-based notebooks (e.g. in jupytext myst:md format). These are super handy in certain contexts -- especially in the aforementioned context of education.

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.

5 participants