Skip to content

Commit 910b3ac

Browse files
add note on how to re-run notebooks with pixi
1 parent 4c2c303 commit 910b3ac

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/sphinx/source/developer_notes.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,27 @@ Or to run all notebooks at once using the pixi task:
274274
pixi run -e dev nbval
275275

276276

277+
Re-running and saving notebook outputs
278+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
279+
280+
If notebook outputs need to be refreshed (e.g. after a code change that
281+
affects plots or printed results), you can re-execute all notebooks in place
282+
using ``jupyter nbconvert``:
283+
284+
::
285+
286+
pixi run -e dev jupyter nbconvert --to notebook --execute --inplace docs/*.ipynb
287+
288+
Or a single notebook:
289+
290+
::
291+
292+
pixi run -e dev jupyter nbconvert --to notebook --execute --inplace docs/TrendAnalysis_example.ipynb
293+
294+
This overwrites each notebook file with freshly executed outputs. Review the
295+
diffs before committing to make sure the changes look correct.
296+
297+
277298
Checking for code style
278299
-----------------------
279300

0 commit comments

Comments
 (0)