IPython Documentation

Table Of Contents

Previous topic

Module: nbconvert.filters.strings

Next topic

Module: nbconvert.postprocessors.base

This Page

Note

This documentation is for a development version of IPython. There may be significant differences from the latest stable release.

Module: nbconvert.nbconvertapp

NbConvert is a utility for conversion of .ipynb files.

Command-line interface for the NbConvert conversion utility.

2 Classes

class IPython.nbconvert.nbconvertapp.DottedOrNone(default_value=<IPython.utils.traitlets.NoDefaultSpecified object at 0x7f9367372fd0>, allow_none=None, **metadata)

Bases: IPython.utils.traitlets.DottedObjectName

A string holding a valid dotted object name in Python, such as A.b3._c Also allows for None type.

class IPython.nbconvert.nbconvertapp.NbConvertApp(**kwargs)

Bases: IPython.core.application.BaseIPythonApplication

Application used to convert from notebook file type (*.ipynb)

convert_notebooks()

Convert the notebooks in the self.notebook traitlet

init_notebooks()

Construct the list of notebooks. If notebooks are passed on the command-line, they override notebooks specified in config files. Glob each notebook to replace notebook patterns with filenames.

init_postprocessor()

Initialize the postprocessor (which is stateless)

init_syspath()

Add the cwd to the sys.path ($PYTHONPATH)

init_writer()

Initialize the writer (which is stateless)

start()

Ran after initialization completed