diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 045f30c3c..633567a9d 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -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:: @@ -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