From b2d3d3b5d581969b3bfddd7e85a45cf4aa4fa9a0 Mon Sep 17 00:00:00 2001 From: Alessio Buccino Date: Fri, 28 Jun 2024 15:33:53 +0200 Subject: [PATCH] Update jupytext readme --- examples/how_to/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/examples/how_to/README.md b/examples/how_to/README.md index af17859ca7..01f11a7a28 100644 --- a/examples/how_to/README.md +++ b/examples/how_to/README.md @@ -14,17 +14,21 @@ with `nbconvert`. Here are the steps (in this example for the `get_started`): ``` >>> jupytext --to notebook get_started.py +>>> jupytext --set-formats ipynb,py get_started.ipynb ``` 2. Run the notebook +3. Sync the run notebook to the .py file: -3. Convert the notebook to .rst +``` +>>> jupytext --sync get_started.ipynb +``` + +4. Convert the notebook to .rst ``` >>> jupyter nbconvert get_started.ipynb --to rst ->>> jupyter nbconvert analyse_neuropixels.ipynb --to rst ``` - -4. Move the .rst and associated folder (e.g. `get_started.rst` and `get_started_files` folder) to the `doc/how_to`. +5. Move the .rst and associated folder (e.g. `get_started.rst` and `get_started_files` folder) to the `doc/how_to`.