10000 Investigate jupytext for code conversion · Issue #424 · sphinx-gallery/sphinx-gallery · GitHub
[go: up one dir, main page]
Skip to content

Investigate jupytext for code conversion #424

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.

Sign up for GitHub

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

Jump to bottom
Open
choldgraf opened this issue Oct 18, 2018 · 1 comment
Open

Investigate jupytext for code conversion #424

choldgraf opened this issue Oct 18, 2018 · 1 comment

Comments

@choldgraf
Copy link
Contributor

There's an interesting project called "jupytext" (https://github.com/mwouts/jupytext) that, as far as I can tell provides a lightweight "python to jupyter notebook" converter (they even already support sphinx gallery format).

Anybody have experience with the project before?
@choldgraf choldgraf mentioned this issue Nov 17, 2018
Closed
@mwouts
Copy link
mwouts commented Nov 17, 2018

Hello @choldgraf , thanks for your interest in Jupytext. Let me comment a bit more on Jupytext and sphinx-gallery:

  • Jupytext is a two way converter, with lots of efforts invested in testing the round trip conversion.
  • For the sphinx format, the parsing of cells is done by Jupytext itself, while the optional conversion from rST to md is done using sphinx-gallery.
  • My initial recommendations on how to use Jupytext with Sphinx galleries are here. As far as I know these recommendations have not been tested extensively by Sphinx users, so feedback is more than welcome!
  • Those who want to edit sphinx gallery scripts with Jupytext in Jupyter should set the freeze_metadata option to avoid creating the YAML header.

@choldgraf choldgraf mentioned this issue Jan 31, 2020
Open
@choldgraf choldgraf mentioned this issue Mar 14, 2020
Closed
@larsoner larsoner mentioned this issue Mar 17, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@choldgraf @mwouts
0