Skip to content

Commit

Permalink
Update jupytext readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alejoe91 committed Jun 28, 2024
1 parent 8b16006 commit b2d3d3b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions examples/how_to/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit b2d3d3b

Please sign in to comment.