Skip to content
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

Document --inplace command line flag. #839

Merged
merged 2 commits into from
Aug 29, 2018
Merged

Document --inplace command line flag. #839

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f668b2f
Fixed spelling
rlabbe Jul 14, 2018
8f58ed4
Documented '--inplace' command line flag.
rlabbe Jul 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/source/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,12 @@ Notebook and preprocessors
jupyter nbconvert --to notebook --execute mynotebook.ipynb

This will open the notebook, execute it, capture new output, and save the
result in :file:`mynotebook.nbconvert.ipynb`. By default, ``nbconvert`` will
abort conversion if any exceptions occur during execution of a cell. If you
specify ``--allow-errors`` (in addition to the ``--execute`` flag) then
conversion will continue and the output from any exception will be included
in the cell output.
result in :file:`mynotebook.nbconvert.ipynb`. Specifying ``--inplace`` will
overwrite the input file instead of writing a new file. By default,
``nbconvert`` will abort conversion if any exceptions occur during
execution of a cell. If you specify ``--allow-errors`` (in addition to the
`--execute`` flag) then conversion will continue and the output from any
exception will be included in the cell output.

The following command::

Expand All @@ -244,7 +245,7 @@ The following command::
will create a copy of :file:`mynotebook.ipynb` in :file:`mynotebook.v3.ipynb`
in version 3 of the notebook format.

If you want to convert a notebook in-place, you can specify the ouptut file
If you want to convert a notebook in-place, you can specify the output file
to be the same as the input file::

jupyter nbconvert --to notebook mynb --output mynb
Expand Down