Configuration optionsΒΆ
These options can be set in ~/.jupyter/jupyter_nbconvert_config.py
, or
at the command line when you start it.
- 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:
''
Full path of a config file.
- JupyterApp.config_file_name : Unicode
Default:
''
Specify a config file to load.
- JupyterApp.generate_config : Bool
Default:
False
Generate default config file.
- NbConvertApp.export_format : ‘custom’|’html’|’latex’|’markdown’|’notebook’|’pdf’|’python’|’rst’|’script’|’slides’
Default:
'html'
The export format to be used.
- NbConvertApp.notebooks : List
Default:
traitlets.Undefined
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:
''
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:
traitlets.Undefined
An ordered list of preferred output type, the first encountered will usually be used when converting discarding the others.
- Exporter.default_preprocessors : List
Default:
traitlets.Undefined
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:
traitlets.Undefined
List of preprocessors, by name or namespace, to enable.
- TemplateExporter.filters : Dict
Default:
traitlets.Undefined
Dictionary of filters, by name and namespace, to add to the Jinja environment.
- TemplateExporter.raw_mimetypes : List
Default:
traitlets.Undefined
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:
''
Name of the template file to use
- TemplateExporter.template_path : List
Default:
traitlets.Undefined
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:
traitlets.Undefined
Shell command used to run bibtex.
- PDFExporter.latex_command : List
Default:
traitlets.Undefined
Shell command used to compile latex.
- PDFExporter.latex_count : Int
Default:
3
How many times latex will be called.
- PDFExporter.temp_file_exts : List
Default:
traitlets.Undefined
File extensions of temp files to remove after running.
- PDFExporter.verbose : Bool
Default:
False
Whether to display the output of latex commands.
- Preprocessor.enabled : Bool
Default:
False
No description
- CSSHTMLHeaderPreprocessor.highlight_class : Unicode
Default:
'.highlight'
CSS highlight class identifier
- ConvertFiguresPreprocessor.from_format : Unicode
Default:
''
Format the converter accepts
- ConvertFiguresPreprocessor.to_format : Unicode
Default:
''
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 : Int
Default:
30
The time to wait (in seconds) for output from executions.
- ExtractOutputPreprocessor.extract_output_types : Set
Default:
traitlets.Undefined
No description
- ExtractOutputPreprocessor.output_filename_template : Unicode
Default:
'{unique_key}_{cell_index}_{index}{extension}'
No description
- HighlightMagicsPreprocessor.languages : Dict
Default:
traitlets.Undefined
Syntax highlighting for magic’s extension languages. Each item associates a language magic extension such as %%R, with a pygments lexer such as r.
- RevealHelpPreprocessor.url_prefix : Unicode
Default:
'reveal.js'
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.
- SVG2PDFPreprocessor.command : Unicode
Default:
''
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:
''
The path to Inkscape, if necessary
- WriterBase.files : List
Default:
traitlets.Undefined
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://cdn.jsdelivr.net/reveal.js/2.6.2'
URL for reveal.js CDN.
- ServePostProcessor.reveal_prefix : Unicode
Default:
'reveal.js'
URL prefix for reveal.js