Warning

This documentation is for an old version of IPython. You can find docs for newer versions here.

Module: nbconvert.transformers.sphinx

Module that allows custom Sphinx parameters to be set on the notebook and on the ‘other’ object passed into Jinja. Called prior to Jinja conversion process.

1 Class

class IPython.nbconvert.transformers.sphinx.SphinxTransformer(**kw)

Bases: IPython.nbconvert.transformers.base.Transformer

Sphinx utility transformer.

This transformer is used to set variables needed by the latex to build Sphinx stylized templates.

call(nb, resources)

Sphinx transformation to apply on each notebook.

Parameters:

nb : NotebookNode

Notebook being converted

resources : dictionary

Additional resources used in the conversion process. Allows transformers to pass variables into the Jinja engine.