JUPYTER-NBCONVERT(1) | User Commands | JUPYTER-NBCONVERT(1) |
jupyter-nbconvert - Convert notebook files (*.ipynb) to various other formats.
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 information on full configurables, see '--help-all'.
-y
--execute
--allow-errors
--stdout
--debug
--inplace
--generate-config
--reveal-prefix=<Unicode> (RevealHelpPreprocessor.url_prefix)
--nbformat=<Enum> (NotebookExporter.nbformat_version)
--writer=<DottedObjectName> (NbConvertApp.writer_class)
--log-level=<Enum> (Application.log_level)
--to=<CaselessStrEnum> (NbConvertApp.export_format)
--template=<Unicode> (TemplateExporter.template_file)
--output=<Unicode> (NbConvertApp.output_base)
--post=<DottedOrNone> (NbConvertApp.postprocessor_class)
--config=<Unicode> (JupyterApp.config_file)
To see all available configurables, use `--help-all`
The simplest way to use nbconvert is
which will convert mynotebook.ipynb to the default format (probably HTML).
You can specify the export format with `--to`. Options include ['custom', 'html', 'latex', 'markdown', 'notebook', 'pdf', 'python', 'rst', 'script', 'slides']
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.
You can also pipe the output to stdout, rather than a file
PDF is generated via latex
You can get (and serve) a Reveal.js-powered slideshow
Multiple notebooks can be given at the command line in a couple of different ways:
or you can specify the notebooks list in a config file, containing::
c.NbConvertApp.notebooks = ["my_notebook.ipynb"]
October 2015 | jupyter-nbconvert 4.0.0 |