JUPYTER-NBCONVERT(1) User Commands JUPYTER-NBCONVERT(1)
NAME
jupyter-nbconvert - Convert notebook files (*.ipynb) to various other
formats.
DESCRIPTION
WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.
Arguments that take values are actually convenience aliases to full
Configurables, whose aliases are listed on the help line. For more in-
formation on full configurables, see '--help-all'.
-y
Answer yes to any questions instead of prompting.
--execute
Execute the notebook prior to export.
--allow-errors
Continue notebook execution even if one of the cells throws an
error and include the error message in the cell output (the de-
fault behaviour is to abort conversion). This flag is only rele-
vant if '--execute' was specified, too.
--stdout
Write notebook output to stdout instead of files.
--debug
set log level to logging.DEBUG (maximize logging output)
--inplace
Run nbconvert in place, overwriting the existing notebook (only
relevant when converting to notebook format)
--generate-config
generate default config file
--reveal-prefix=<Unicode> (RevealHelpPreprocessor.url_prefix)
The URL prefix for reveal.js. This can be a a relative URL for a
local copy of reveal.js, or point to a CDN. For speaker notes to
work, a local reveal.js prefix must be used. (default: 're-
veal.js')
--nbformat=<Enum> (NotebookExporter.nbformat_version)
The nbformat version to write. Use this to downgrade notebooks.
Choices: [1, 2, 3, 4] (with default 4)
--writer=<DottedObjectName> (NbConvertApp.writer_class)
Writer class used to write the results of the conversion (de-
fault: 'FilesWriter')
--log-level=<Enum> (Application.log_level)
Set the log level by value or name. Choices: (0, 10, 20, 30, 40,
50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') (default: 30)
--to=<CaselessStrEnum> (NbConvertApp.export_format)
The export format to be used. Choices: ['custom', 'html', 'la-
tex', 'markdown',
'notebook', 'pdf', 'python', 'rst', 'script', 'slides'] (de-
fault: 'html')
--template=<Unicode> (TemplateExporter.template_file)
Name of the template file to use (default: u'')
--output=<Unicode> (NbConvertApp.output_base)
overwrite base name use for output files. can only be used when
converting one notebook at a time (default: '').
--post=<DottedOrNone> (NbConvertApp.postprocessor_class)
PostProcessor class used to write the results of the conversion
(default u'')
--config=<Unicode> (JupyterApp.config_file)
Full path of a config file (default: u'').
To see all available configurables, use `--help-all`
EXAMPLES
The simplest way to use nbconvert is
jupyter nbconvert mynotebook.ipynb
which will convert mynotebook.ipynb to the default format (probably
HTML).
You can specify the export format with `--to`. Options include ['cus-
tom', 'html', 'latex', 'markdown', 'notebook', 'pdf', 'python', 'rst',
'script', 'slides']
jupyter nbconvert --to latex mynotebook.ipynb
Both HTML and LaTeX support multiple output templates. LaTeX includes
'base', 'article' and 'report'. HTML includes 'basic' and 'full'. You
can specify the flavor of the format used.
jupyter nbconvert --to html --template basic mynotebook.ipynb
You can also pipe the output to stdout, rather than a file
jupyter nbconvert mynotebook.ipynb --stdout
PDF is generated via latex
jupyter nbconvert mynotebook.ipynb --to pdf
You can get (and serve) a Reveal.js-powered slideshow
jupyter nbconvert myslides.ipynb --to slides --post serve
Multiple notebooks can be given at the command line in a couple of dif-
ferent ways:
jupyter nbconvert notebook*.ipynb
jupyter nbconvert notebook1.ipynb notebook2.ipynb
or you can specify the notebooks list in a config file, containing::
c.NbConvertApp.notebooks = ["my_notebook.ipynb"]
jupyter nbconvert --config mycfg.py
jupyter-nbconvert 4.0.0 October 2015 JUPYTER-NBCONVERT(1)
Generated by dwww version 1.15 on Thu Jun 20 14:17:34 CEST 2024.