Warning
This documentation is for an old version of IPython. You can find docs for newer versions here.
This module defines Exporter, a highly configurable converter that uses Jinja2 to export notebook files into different formats.
Bases: collections.defaultdict
Bases: IPython.config.configurable.LoggingConfigurable
Exports notebooks into other file formats. Uses Jinja 2 templating engine to output new formats. Inherit from this class if you are creating a new template type along with new filters/transformers. If the filters/ transformers provided by default suffice, there is no need to inherit from this class. Instead, override the template_file and file_extension traits via a config file.
Public constructor
Parameters: | config : config
extra_loaders : list[of Jinja Loaders]
template : str (optional, kw arg)
|
---|
Convert a notebook from a notebook file.
Parameters: | file_stream : file-like object
|
---|
Convert a notebook from a notebook file.
Parameters: | filename : str
|
---|
Convert a notebook from a notebook node instance.
Parameters: | nb : Notebook node resources : dict (**kw)
|
---|
Register a filter. A filter is a function that accepts and acts on one string. The filters are accesible within the Jinja templating engine.
Parameters: | name : str
filter : filter |
---|
Register a transformer. Transformers are classes that act upon the notebook before it is passed into the Jinja templating engine. Transformers are also capable of passing additional information to the Jinja templating engine.
Parameters: | transformer : transformer |
---|