From 18e1b160c64267a541a6646fe848df40d80091f1 Mon Sep 17 00:00:00 2001 From: Matthew Seal Date: Fri, 25 Sep 2020 16:21:56 -0700 Subject: [PATCH] Updated with default conversion changes from 6.0 in documentation (#1426) * Updated with default conversion changes from 6.0 in documentation * Fixed doc references --- docs/source/changelog.rst | 1 + docs/source/usage.rst | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 8394c97ff..78e4d374b 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -531,6 +531,7 @@ New Features Deprecations ++++++++++++ - Drop support for python 3.3 :ghpull:`843` +- Default conversion method on the CLI was removed (``--to html`` now required) Fixing Problems +++++++++++++++ diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 301f8fbee..052116b23 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -10,12 +10,12 @@ The command-line syntax to run the ``nbconvert`` script is:: This will convert the Jupyter notebook file ``notebook.ipynb`` into the output format given by the ``FORMAT`` string. -Default output format - HTML ----------------------------- -The default output format is HTML, for which the ``--to`` argument may be -omitted:: +Default output format +--------------------- - $ jupyter nbconvert notebook.ipynb +In 5.x versions of nbconvert the default output format was html. In 6.0 the default was removed, +requiring CLI calls to explicitly set a ``--to`` argument in order to execute. To mimic original +5.x behavior one should add ``--to=html`` to the ``jupyter nbconvert`` command. .. _supported_output: