Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Use `jupytext`-compatible markdown files instead of notebooks?

See original GitHub issue

Notebooks don’t work well with versioning, but the markdown files produced by jupytext do. I suggest we only version the markdown versions in the repository, and render the notebooks for the documentation.

Edit: We use MyST-nb to build documentation from notebooks, and it does support notebooks in jupytext format. It is just a matter of converting the notebooks and configure the build in CI.

Issue Analytics

State:
Created 2 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

rloufcommented, Jun 30, 2022

I haven’t actually started so feel free to pick it up. It’s best to start with one example and open a draft PR to set things up and for feedback.

0reactions

bkktimbercommented, Jun 30, 2022

Got it. Thank you!

Top Results From Across the Web

Frequently Asked Questions - Jupytext documentation

Pair the notebook to a script or a Markdown file using either the Jupytext Menu in Jupyter Notebook or the Jupytext Commands in...

Jupyter notebooks as Markdown documents or Python scripts

Jupytext is a Jupyter plugin that allows you to convert Jupyter notebooks to Markdown or Python script files and back again.

mwouts/jupytext: Jupyter Notebooks as Markdown ... - GitHub

Jupyter Notebooks as Markdown Documents, Julia, Python or R scripts ... In the latest version of Jupytext, this extension is compatible with Jupyter...

Notebooks written entirely in Markdown - Jupyter Book

The easiest way to create a MyST notebook is to use Jupytext, a tool that allows for two-way conversion between .ipynb and a...

Marc Wouts - Jupytext: Jupyter Notebooks as Markdown ...

Outline Why Jupytext : going further than the .ipynb format Jupytext's approach: use Jupyter Notebooks, but store them as .py or .md files...