
.. This is an automatically generated file.
.. do not modify by hand.

Configuration options
=====================

Configuration options may be set in a file, ``~/.jupyter/jupyter_nbconvert_config.py``,
or at the command line when starting nbconvert, i.e. ``jupyter nbconvert --Application.log_level=10``.



Application.log_datefmt : Unicode
    Default: ``'%Y-%m-%d %H:%M:%S'``

    The date format used by logging formatters for %(asctime)s

Application.log_format : Unicode
    Default: ``'[%(name)s]%(highlevel)s %(message)s'``

    The Logging format template

Application.log_level : 0|10|20|30|40|50|'DEBUG'|'INFO'|'WARN'|'ERROR'|'CRITICAL'
    Default: ``30``

    Set the log level by value or name.

JupyterApp.answer_yes : Bool
    Default: ``False``

    Answer yes to any prompts.

JupyterApp.config_file : Unicode
    Default: ``u''``

    Full path of a config file.

JupyterApp.config_file_name : Unicode
    Default: ``u''``

    Specify a config file to load.

JupyterApp.generate_config : Bool
    Default: ``False``

    Generate default config file.

NbConvertApp.export_format : u'custom'|u'html'|u'latex'|u'markdown'|u'notebook'|u'pdf'|u'python'|u'rst'|u'script'|u'slides'
    Default: ``'html'``

    The export format to be used.

NbConvertApp.notebooks : List
    Default: ``[]``

    List of notebooks to convert.
    Wildcards are supported.
    Filenames passed positionally will be added to the list.


NbConvertApp.output_base : Unicode
    Default: ``''``

    overwrite base name use for output files.
    can only be used when converting one notebook at a time.


NbConvertApp.postprocessor_class : DottedOrNone
    Default: ``u''``

    PostProcessor class used to write the 
    results of the conversion

NbConvertApp.use_output_suffix : Bool
    Default: ``True``

    Whether to apply a suffix prior to the extension (only relevant
    when converting to notebook format). The suffix is determined by
    the exporter, and is usually '.nbconvert'.

NbConvertApp.writer_class : DottedObjectName
    Default: ``'FilesWriter'``

    Writer class used to write the 
    results of the conversion

NbConvertBase.default_language : Unicode
    Default: ``'ipython'``

    DEPRECATED default highlight language, please use language_info metadata instead

NbConvertBase.display_data_priority : List
    Default: ``['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...``

    
    An ordered list of preferred output type, the first
    encountered will usually be used when converting discarding
    the others.


Exporter.default_preprocessors : List
    Default: ``['nbconvert.preprocessors.ClearOutputPreprocessor', 'nbconver...``

    List of preprocessors available by default, by name, namespace, 
    instance, or type.

Exporter.file_extension : FilenameExtension
    Default: ``'.txt'``

    Extension of the file that should be written to disk

Exporter.preprocessors : List
    Default: ``[]``

    List of preprocessors, by name or namespace, to enable.

TemplateExporter.filters : Dict
    Default: ``{}``

    Dictionary of filters, by name and namespace, to add to the Jinja
    environment.

TemplateExporter.raw_mimetypes : List
    Default: ``[]``

    formats of raw cells to be included in this Exporter's output.

TemplateExporter.template_extension : Unicode
    Default: ``'.tpl'``

    No description

TemplateExporter.template_file : Unicode
    Default: ``u''``

    Name of the template file to use

TemplateExporter.template_path : List
    Default: ``['.']``

    No description


LatexExporter.template_extension : Unicode
    Default: ``'.tplx'``

    No description


NotebookExporter.nbformat_version : 1|2|3|4
    Default: ``4``

    The nbformat version to write.
    Use this to downgrade notebooks.


PDFExporter.bib_command : List
    Default: ``[u'bibtex', u'{filename}']``

    Shell command used to run bibtex.

PDFExporter.latex_command : List
    Default: ``[u'pdflatex', u'{filename}']``

    Shell command used to compile latex.

PDFExporter.latex_count : Integer
    Default: ``3``

    How many times latex will be called.

PDFExporter.temp_file_exts : List
    Default: ``['.aux', '.bbl', '.blg', '.idx', '.log', '.out']``

    File extensions of temp files to remove after running.

PDFExporter.verbose : Bool
    Default: ``False``

    Whether to display the output of latex commands.



SlidesExporter.reveal_url_prefix : Unicode
    Default: ``u''``

    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.


Preprocessor.enabled : Bool
    Default: ``False``

    No description

CSSHTMLHeaderPreprocessor.highlight_class : Unicode
    Default: ``'.highlight'``

    CSS highlight class identifier


ConvertFiguresPreprocessor.from_format : Unicode
    Default: ``u''``

    Format the converter accepts

ConvertFiguresPreprocessor.to_format : Unicode
    Default: ``u''``

    Format the converter writes

ExecutePreprocessor.allow_errors : Bool
    Default: ``False``

    
    If `True`, a `CellExecutionError` is raised if any of the notebook
    cells raises an exception during execution. Otherwise, execution
    is continued and the output from the exception is included in the
    cell output.


ExecutePreprocessor.interrupt_on_timeout : Bool
    Default: ``False``

    
    If execution of a cell times out, interrupt the kernel and
    continue executing other cells rather than throwing an error and
    stopping.


ExecutePreprocessor.timeout : Integer
    Default: ``30``

    The time to wait (in seconds) for output from executions.

ExtractOutputPreprocessor.extract_output_types : Set
    Default: ``set(['image/png', 'application/pdf', 'image/jpeg', 'image/svg...``

    No description

ExtractOutputPreprocessor.output_filename_template : Unicode
    Default: ``'{unique_key}_{cell_index}_{index}{extension}'``

    No description

HighlightMagicsPreprocessor.languages : Dict
    Default: ``{}``

    Syntax highlighting for magic's extension languages. Each item associates a language magic extension such as %%R, with a pygments lexer such as r.


SVG2PDFPreprocessor.command : Unicode
    Default: ``u''``

    The command to use for converting SVG to PDF
    
    This string is a template, which will be formatted with the keys
    to_filename and from_filename.
    
    The conversion call must read the SVG from {from_flename},
    and write a PDF to {to_filename}.


SVG2PDFPreprocessor.inkscape : Unicode
    Default: ``u''``

    The path to Inkscape, if necessary

WriterBase.files : List
    Default: ``[]``

    
    List of the files that the notebook references.  Files will be 
    included with written output.


FilesWriter.build_directory : Unicode
    Default: ``''``

    Directory to write output to.  Leave blank
    to output to the current directory

FilesWriter.relpath : Unicode
    Default: ``''``

    When copying files that the notebook depends on, copy them in
    relation to this path, such that the destination filename will be
    os.path.relpath(filename, relpath). If FilesWriter is operating on a
    notebook that already exists elsewhere on disk, then the default will be
    the directory containing that notebook.



ServePostProcessor.ip : Unicode
    Default: ``'127.0.0.1'``

    The IP address to listen on.

ServePostProcessor.open_in_browser : Bool
    Default: ``True``

    Should the browser be opened automatically?

ServePostProcessor.port : Int
    Default: ``8000``

    port for the server to listen on.

ServePostProcessor.reveal_cdn : Unicode
    Default: ``'https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.1.0'``

    URL for reveal.js CDN.

ServePostProcessor.reveal_prefix : Unicode
    Default: ``'reveal.js'``

    URL prefix for reveal.js
