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.
The most specific setting will always be used. For example, the LatexExporter and the HTMLExporter both inherit from TemplateExporter. With the following config
c.TemplateExporter.exclude_input_prompt = False # The default
c.PDFExporter.exclude_input_prompt = True
input prompts will not appear when converting to PDF, but they will appear when exporting to HTML.
CLI Flags and Aliases¶
When using Nbconvert from the command line, a number of aliases and flags are defined as shortcuts to configuration options for convience.
The following flags are defined:
- debug
set log level to logging.DEBUG (maximize logging output)
Long Form: {‘Application’: {‘log_level’: 10}}
- generate-config
generate default config file
Long Form: {‘JupyterApp’: {‘generate_config’: True}}
- y
Answer yes to any questions instead of prompting.
Long Form: {‘JupyterApp’: {‘answer_yes’: True}}
- execute
Execute the notebook prior to export.
Long Form: {‘ExecutePreprocessor’: {‘enabled’: True}}
- allow-errors
Continue notebook execution even if one of the cells throws an error and include the error message in the cell output (the default behaviour is to abort conversion). This flag is only relevant if ‘–execute’ was specified, too.
Long Form: {‘ExecutePreprocessor’: {‘allow_errors’: True}}
- stdin
read a single notebook file from stdin. Write the resulting notebook with default basename ‘notebook.*’
Long Form: {‘NbConvertApp’: {‘from_stdin’: True}}
- stdout
Write notebook output to stdout instead of files.
Long Form: {‘NbConvertApp’: {‘writer_class’: ‘StdoutWriter’}}
- inplace
Run nbconvert in place, overwriting the existing notebook (only relevant when converting to notebook format)
Long Form: {‘NbConvertApp’: {‘use_output_suffix’: False, ‘export_format’: ‘notebook’}, ‘FilesWriter’: {‘build_directory’: ‘’}}
- clear-output
Clear output of current file and save in place, overwriting the existing notebook.
Long Form: {‘NbConvertApp’: {‘use_output_suffix’: False, ‘export_format’: ‘notebook’}, ‘FilesWriter’: {‘build_directory’: ‘’}, ‘ClearOutputPreprocessor’: {‘enabled’: True}}
- no-prompt
Exclude input and output prompts from converted document.
Long Form: {‘TemplateExporter’: {‘exclude_input_prompt’: True, ‘exclude_output_prompt’: True}}
- no-input
Exclude input cells and output prompts from converted document. This mode is ideal for generating code-free reports.
Long Form: {‘TemplateExporter’: {‘exclude_output_prompt’: True, ‘exclude_input’: True}}
- allow-chromium-download
Whether to allow downloading chromium if no suitable version is found on the system.
Long Form: {‘WebPDFExporter’: {‘allow_chromium_download’: True}}
The folowing aliases are defined:
log-level (Application.log_level)
config (JupyterApp.config_file)
to (NbConvertApp.export_format)
template (TemplateExporter.template_name)
template-file (TemplateExporter.template_file)
writer (NbConvertApp.writer_class)
post (NbConvertApp.postprocessor_class)
output (NbConvertApp.output_base)
output-dir (FilesWriter.build_directory)
reveal-prefix (SlidesExporter.reveal_url_prefix)
nbformat (NotebookExporter.nbformat_version)
App Options¶
- 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 : any of
0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’`` Default:
30Set the log level by value or name.
- Application.show_config : Bool
Default:
FalseInstead of starting the Application, dump configuration to stdout
- Application.show_config_json : Bool
Default:
FalseInstead of starting the Application, dump configuration to stdout (as JSON)
- JupyterApp.answer_yes : Bool
Default:
FalseAnswer 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:
FalseGenerate default config file.
- JupyterApp.log_datefmt : Unicode
Default:
'%Y-%m-%d %H:%M:%S'The date format used by logging formatters for %(asctime)s
- JupyterApp.log_format : Unicode
Default:
'[%(name)s]%(highlevel)s %(message)s'The Logging format template
- JupyterApp.log_level : any of
0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’`` Default:
30Set the log level by value or name.
- JupyterApp.show_config : Bool
Default:
FalseInstead of starting the Application, dump configuration to stdout
- JupyterApp.show_config_json : Bool
Default:
FalseInstead of starting the Application, dump configuration to stdout (as JSON)
- NbConvertApp.answer_yes : Bool
Default:
FalseAnswer yes to any prompts.
- NbConvertApp.config_file : Unicode
Default:
''Full path of a config file.
- NbConvertApp.config_file_name : Unicode
Default:
''Specify a config file to load.
- NbConvertApp.export_format : Unicode
Default:
''The export format to be used, either one of the built-in formats [‘asciidoc’, ‘custom’, ‘html’, ‘latex’, ‘markdown’, ‘notebook’, ‘pdf’, ‘python’, ‘rst’, ‘script’, ‘slides’, ‘webpdf’] or a dotted object name that represents the import path for an
Exporterclass- NbConvertApp.from_stdin : Bool
Default:
Falseread a single notebook from stdin.
- NbConvertApp.generate_config : Bool
Default:
FalseGenerate default config file.
- NbConvertApp.html_manager_semver_range : Unicode
Default:
'*'Semver range for Jupyter widgets HTML manager
- NbConvertApp.jupyter_widgets_base_url : Unicode
Default:
'https://unpkg.com/'URL base for Jupyter widgets
- NbConvertApp.log_datefmt : Unicode
Default:
'%Y-%m-%d %H:%M:%S'The date format used by logging formatters for %(asctime)s
- NbConvertApp.log_format : Unicode
Default:
'[%(name)s]%(highlevel)s %(message)s'The Logging format template
- NbConvertApp.log_level : any of
0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’`` Default:
30Set the log level by value or name.
- 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.output_files_dir : Unicode
Default:
'{notebook_name}_files'Directory to copy extra files (figures) to. ‘{notebook_name}’ in the string will be converted to notebook basename.
- NbConvertApp.postprocessor_class : DottedOrNone
Default:
''PostProcessor class used to write the results of the conversion
- NbConvertApp.show_config : Bool
Default:
FalseInstead of starting the Application, dump configuration to stdout
- NbConvertApp.show_config_json : Bool
Default:
FalseInstead of starting the Application, dump configuration to stdout (as JSON)
- NbConvertApp.use_output_suffix : Bool
Default:
TrueWhether 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
Exporter Options¶
- Exporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- Exporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- Exporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- Exporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- TemplateExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- TemplateExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- TemplateExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- TemplateExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- TemplateExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- TemplateExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- TemplateExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- TemplateExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- TemplateExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- TemplateExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- TemplateExporter.extra_template_basedirs : List
Default:
[]No description
- TemplateExporter.extra_template_paths : List
Default:
[]No description
- TemplateExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- TemplateExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- TemplateExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- TemplateExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- TemplateExporter.template_extension : Unicode
Default:
''No description
- TemplateExporter.template_file : Unicode
Default:
NoneName of the template file to use
- TemplateExporter.template_name : Unicode
Default:
''Name of the template to use
- TemplateExporter.template_paths : List
Default:
['.']No description
- ASCIIDocExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- ASCIIDocExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- ASCIIDocExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- ASCIIDocExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- ASCIIDocExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- ASCIIDocExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- ASCIIDocExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- ASCIIDocExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- ASCIIDocExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- ASCIIDocExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- ASCIIDocExporter.extra_template_basedirs : List
Default:
[]No description
- ASCIIDocExporter.extra_template_paths : List
Default:
[]No description
- ASCIIDocExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- ASCIIDocExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- ASCIIDocExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- ASCIIDocExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- ASCIIDocExporter.template_extension : Unicode
Default:
''No description
- ASCIIDocExporter.template_file : Unicode
Default:
NoneName of the template file to use
- ASCIIDocExporter.template_name : Unicode
Default:
''Name of the template to use
- ASCIIDocExporter.template_paths : List
Default:
['.']No description
- HTMLExporter.anchor_link_text : Unicode
Default:
'¶'The text used as the text for anchor links.
- HTMLExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- HTMLExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- HTMLExporter.exclude_anchor_links : Bool
Default:
FalseIf anchor links should be included or not.
- HTMLExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- HTMLExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- HTMLExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- HTMLExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- HTMLExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- HTMLExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- HTMLExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- HTMLExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- HTMLExporter.extra_template_basedirs : List
Default:
[]No description
- HTMLExporter.extra_template_paths : List
Default:
[]No description
- HTMLExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- HTMLExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- HTMLExporter.jquery_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.m...URL to load jQuery from.
Defaults to loading from cdnjs.
- HTMLExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- HTMLExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- HTMLExporter.require_js_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/req...URL to load require.js from.
Defaults to loading from cdnjs.
- HTMLExporter.template_extension : Unicode
Default:
''No description
- HTMLExporter.template_file : Unicode
Default:
NoneName of the template file to use
- HTMLExporter.template_name : Unicode
Default:
''Name of the template to use
- HTMLExporter.template_paths : List
Default:
['.']No description
- HTMLExporter.theme : Unicode
Default:
'light'Template specific theme(e.g. the JupyterLab CSS theme for the lab template)
- LatexExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- LatexExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- LatexExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- LatexExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- LatexExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- LatexExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- LatexExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- LatexExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- LatexExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- LatexExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- LatexExporter.extra_template_basedirs : List
Default:
[]No description
- LatexExporter.extra_template_paths : List
Default:
[]No description
- LatexExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- LatexExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- LatexExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- LatexExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- LatexExporter.template_extension : Unicode
Default:
''No description
- LatexExporter.template_file : Unicode
Default:
NoneName of the template file to use
- LatexExporter.template_name : Unicode
Default:
''Name of the template to use
- LatexExporter.template_paths : List
Default:
['.']No description
- MarkdownExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- MarkdownExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- MarkdownExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- MarkdownExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- MarkdownExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- MarkdownExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- MarkdownExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- MarkdownExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- MarkdownExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- MarkdownExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- MarkdownExporter.extra_template_basedirs : List
Default:
[]No description
- MarkdownExporter.extra_template_paths : List
Default:
[]No description
- MarkdownExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- MarkdownExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- MarkdownExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- MarkdownExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- MarkdownExporter.template_extension : Unicode
Default:
''No description
- MarkdownExporter.template_file : Unicode
Default:
NoneName of the template file to use
- MarkdownExporter.template_name : Unicode
Default:
''Name of the template to use
- MarkdownExporter.template_paths : List
Default:
['.']No description
- NotebookExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- NotebookExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- NotebookExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- NotebookExporter.nbformat_version : any of
1``|``2``|``3``|``4 Default:
4The nbformat version to write. Use this to downgrade notebooks.
- NotebookExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- PDFExporter.bib_command : List
Default:
['bibtex', '{filename}']Shell command used to run bibtex.
- PDFExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- PDFExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- PDFExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- PDFExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- PDFExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- PDFExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- PDFExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- PDFExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- PDFExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- PDFExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- PDFExporter.extra_template_basedirs : List
Default:
[]No description
- PDFExporter.extra_template_paths : List
Default:
[]No description
- PDFExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- PDFExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- PDFExporter.latex_command : List
Default:
['xelatex', '{filename}', '-quiet']Shell command used to compile latex.
- PDFExporter.latex_count : Int
Default:
3How many times latex will be called.
- PDFExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- PDFExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- PDFExporter.template_extension : Unicode
Default:
''No description
- PDFExporter.template_file : Unicode
Default:
NoneName of the template file to use
- PDFExporter.template_name : Unicode
Default:
''Name of the template to use
- PDFExporter.template_paths : List
Default:
['.']No description
- PDFExporter.verbose : Bool
Default:
FalseWhether to display the output of latex commands.
- PythonExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- PythonExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- PythonExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- PythonExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- PythonExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- PythonExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- PythonExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- PythonExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- PythonExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- PythonExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- PythonExporter.extra_template_basedirs : List
Default:
[]No description
- PythonExporter.extra_template_paths : List
Default:
[]No description
- PythonExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- PythonExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- PythonExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- PythonExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- PythonExporter.template_extension : Unicode
Default:
''No description
- PythonExporter.template_file : Unicode
Default:
NoneName of the template file to use
- PythonExporter.template_name : Unicode
Default:
''Name of the template to use
- PythonExporter.template_paths : List
Default:
['.']No description
- RSTExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- RSTExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- RSTExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- RSTExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- RSTExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- RSTExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- RSTExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- RSTExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- RSTExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- RSTExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- RSTExporter.extra_template_basedirs : List
Default:
[]No description
- RSTExporter.extra_template_paths : List
Default:
[]No description
- RSTExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- RSTExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- RSTExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- RSTExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- RSTExporter.template_extension : Unicode
Default:
''No description
- RSTExporter.template_file : Unicode
Default:
NoneName of the template file to use
- RSTExporter.template_name : Unicode
Default:
''Name of the template to use
- RSTExporter.template_paths : List
Default:
['.']No description
- ScriptExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- ScriptExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- ScriptExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- ScriptExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- ScriptExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- ScriptExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- ScriptExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- ScriptExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- ScriptExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- ScriptExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- ScriptExporter.extra_template_basedirs : List
Default:
[]No description
- ScriptExporter.extra_template_paths : List
Default:
[]No description
- ScriptExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- ScriptExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- ScriptExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- ScriptExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- ScriptExporter.template_extension : Unicode
Default:
''No description
- ScriptExporter.template_file : Unicode
Default:
NoneName of the template file to use
- ScriptExporter.template_name : Unicode
Default:
''Name of the template to use
- ScriptExporter.template_paths : List
Default:
['.']No description
- SlidesExporter.anchor_link_text : Unicode
Default:
'¶'The text used as the text for anchor links.
- SlidesExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- SlidesExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- SlidesExporter.exclude_anchor_links : Bool
Default:
FalseIf anchor links should be included or not.
- SlidesExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- SlidesExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- SlidesExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- SlidesExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- SlidesExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- SlidesExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- SlidesExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- SlidesExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- SlidesExporter.extra_template_basedirs : List
Default:
[]No description
- SlidesExporter.extra_template_paths : List
Default:
[]No description
- SlidesExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- SlidesExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- SlidesExporter.font_awesome_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/cs...URL to load font awesome from.
Defaults to loading from cdnjs.
- SlidesExporter.jquery_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.m...URL to load jQuery from.
Defaults to loading from cdnjs.
- SlidesExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- SlidesExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- SlidesExporter.require_js_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/req...URL to load require.js from.
Defaults to loading from cdnjs.
- SlidesExporter.reveal_scroll : Bool
Default:
FalseIf True, enable scrolling within each slide
- SlidesExporter.reveal_theme : Unicode
Default:
'simple'Name of the reveal.js theme to use.
We look for a file with this name under
reveal_url_prefix/css/theme/reveal_theme.css.https://github.com/hakimel/reveal.js/tree/master/css/theme has list of themes that ship by default with reveal.js.
- SlidesExporter.reveal_transition : Unicode
Default:
'slide'Name of the reveal.js transition to use.
The list of transitions that ships by default with reveal.js are: none, fade, slide, convex, concave and zoom.
- SlidesExporter.reveal_url_prefix : Unicode
Default:
''The URL prefix for reveal.js (version 3.x). This defaults to the reveal CDN, but can be any url pointing to a copy of reveal.js.
For speaker notes to work, this must be a relative path to a local copy of reveal.js: e.g., “reveal.js”.
If a relative path is given, it must be a subdirectory of the current directory (from which the server is run).
See the usage documentation (https://nbconvert.readthedocs.io/en/latest/usage.html#reveal-js-html-slideshow) for more details.
- SlidesExporter.template_extension : Unicode
Default:
''No description
- SlidesExporter.template_file : Unicode
Default:
NoneName of the template file to use
- SlidesExporter.template_name : Unicode
Default:
''Name of the template to use
- SlidesExporter.template_paths : List
Default:
['.']No description
- SlidesExporter.theme : Unicode
Default:
'light'Template specific theme(e.g. the JupyterLab CSS theme for the lab template)
- WebPDFExporter.allow_chromium_download : Bool
Default:
FalseWhether to allow downloading Chromium if no suitable version is found on the system.
- WebPDFExporter.anchor_link_text : Unicode
Default:
'¶'The text used as the text for anchor links.
- WebPDFExporter.default_preprocessors : List
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....List of preprocessors available by default, by name, namespace, instance, or type.
- WebPDFExporter.enabled : Bool
Default:
TrueDisable this exporter (and any exporters inherited from it).
- WebPDFExporter.exclude_anchor_links : Bool
Default:
FalseIf anchor links should be included or not.
- WebPDFExporter.exclude_code_cell : Bool
Default:
FalseThis allows you to exclude code cells from all templates if set to True.
- WebPDFExporter.exclude_input : Bool
Default:
FalseThis allows you to exclude code cell inputs from all templates if set to True.
- WebPDFExporter.exclude_input_prompt : Bool
Default:
FalseThis allows you to exclude input prompts from all templates if set to True.
- WebPDFExporter.exclude_markdown : Bool
Default:
FalseThis allows you to exclude markdown cells from all templates if set to True.
- WebPDFExporter.exclude_output : Bool
Default:
FalseThis allows you to exclude code cell outputs from all templates if set to True.
- WebPDFExporter.exclude_output_prompt : Bool
Default:
FalseThis allows you to exclude output prompts from all templates if set to True.
- WebPDFExporter.exclude_raw : Bool
Default:
FalseThis allows you to exclude raw cells from all templates if set to True.
- WebPDFExporter.exclude_unknown : Bool
Default:
FalseThis allows you to exclude unknown cells from all templates if set to True.
- WebPDFExporter.extra_template_basedirs : List
Default:
[]No description
- WebPDFExporter.extra_template_paths : List
Default:
[]No description
- WebPDFExporter.file_extension : FilenameExtension
Default:
''Extension of the file that should be written to disk
- WebPDFExporter.filters : Dict
Default:
{}Dictionary of filters, by name and namespace, to add to the Jinja environment.
- WebPDFExporter.jquery_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.m...URL to load jQuery from.
Defaults to loading from cdnjs.
- WebPDFExporter.preprocessors : List
Default:
[]List of preprocessors, by name or namespace, to enable.
- WebPDFExporter.raw_mimetypes : List
Default:
[]formats of raw cells to be included in this Exporter’s output.
- WebPDFExporter.require_js_url : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/req...URL to load require.js from.
Defaults to loading from cdnjs.
- WebPDFExporter.template_extension : Unicode
Default:
''No description
- WebPDFExporter.template_file : Unicode
Default:
NoneName of the template file to use
- WebPDFExporter.template_name : Unicode
Default:
''Name of the template to use
- WebPDFExporter.template_paths : List
Default:
['.']No description
- WebPDFExporter.theme : Unicode
Default:
'light'Template specific theme(e.g. the JupyterLab CSS theme for the lab template)
Writer Options¶
- WriterBase.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- WriterBase.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.
- WriterBase.files : List
Default:
[]List of the files that the notebook references. Files will be included with written output.
- DebugWriter.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- DebugWriter.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.
- DebugWriter.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(s) to. Defaults to output to the directory of each notebook. To recover previous default behaviour (outputting to the current working directory) use . as the flag value.
- FilesWriter.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- FilesWriter.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.
- FilesWriter.files : List
Default:
[]List of the files that the notebook references. Files will be included with written output.
- 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.
- StdoutWriter.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- StdoutWriter.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.
- StdoutWriter.files : List
Default:
[]List of the files that the notebook references. Files will be included with written output.
Preprocessor Options¶
- Preprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- Preprocessor.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.
- Preprocessor.enabled : Bool
Default:
FalseNo description
- CSSHTMLHeaderPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- CSSHTMLHeaderPreprocessor.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.
- CSSHTMLHeaderPreprocessor.enabled : Bool
Default:
FalseNo description
- CSSHTMLHeaderPreprocessor.highlight_class : Unicode
Default:
'.highlight'CSS highlight class identifier
- CSSHTMLHeaderPreprocessor.style : Union
Default:
<class 'jupyterlab_pygments.style.JupyterStyle'>Name of the pygments style to use
- ClearMetadataPreprocessor.clear_cell_metadata : Bool
Default:
TrueFlag to choose if cell metadata is to be cleared in addition to notebook metadata.
- ClearMetadataPreprocessor.clear_notebook_metadata : Bool
Default:
TrueFlag to choose if notebook metadata is to be cleared in addition to cell metadata.
- ClearMetadataPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ClearMetadataPreprocessor.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.
- ClearMetadataPreprocessor.enabled : Bool
Default:
FalseNo description
- ClearMetadataPreprocessor.preserve_cell_metadata_mask : Set
Default:
set()Indicates the key paths to preserve when deleting metadata across both cells and notebook metadata fields. Tuples of keys can be passed to preserved specific nested values
- ClearMetadataPreprocessor.preserve_nb_metadata_mask : Set
Default:
{('language_info', 'name')}Indicates the key paths to preserve when deleting metadata across both cells and notebook metadata fields. Tuples of keys can be passed to preserved specific nested values
- ClearOutputPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ClearOutputPreprocessor.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.
- ClearOutputPreprocessor.enabled : Bool
Default:
FalseNo description
- ClearOutputPreprocessor.remove_metadata_fields : Set
Default:
{'collapsed', 'scrolled'}No description
- ConvertFiguresPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ConvertFiguresPreprocessor.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.
- ConvertFiguresPreprocessor.enabled : Bool
Default:
FalseNo description
- ConvertFiguresPreprocessor.from_format : Unicode
Default:
''Format the converter accepts
- ConvertFiguresPreprocessor.to_format : Unicode
Default:
''Format the converter writes
- ExecutePreprocessor.allow_errors : Bool
Default:
FalseIf
False(default), when a cell raises an error the execution is stopped and aCellExecutionErroris raised. IfTrue, execution errors are ignored and the execution is continued until the end of the notebook. Output from exceptions is included in the cell output in both cases.- ExecutePreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ExecutePreprocessor.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.
- ExecutePreprocessor.enabled : Bool
Default:
FalseNo description
- ExecutePreprocessor.extra_arguments : List
Default:
[]No description
- ExecutePreprocessor.force_raise_errors : Bool
Default:
FalseIf False (default), errors from executing the notebook can be allowed with a
raises-exceptiontag on a single cell, or theallow_errorsconfigurable option for all cells. An allowed error will be recorded in notebook output, and execution will continue. If an error occurs when it is not explicitly allowed, aCellExecutionErrorwill be raised. If True,CellExecutionErrorwill be raised for any error that occurs while executing the notebook. This overrides both theallow_errorsoption and theraises-exceptioncell tag.- ExecutePreprocessor.interrupt_on_timeout : Bool
Default:
FalseIf execution of a cell times out, interrupt the kernel and continue executing other cells rather than throwing an error and stopping.
- ExecutePreprocessor.iopub_timeout : Int
Default:
4The time to wait (in seconds) for IOPub output. This generally doesn’t need to be set, but on some slow networks (such as CI systems) the default timeout might not be long enough to get all messages.
- ExecutePreprocessor.ipython_hist_file : Unicode
Default:
':memory:'Path to file to use for SQLite history database for an IPython kernel.
The specific value
:memory:(including the colon at both end but not the back ticks), avoids creating a history file. Otherwise, IPython will create a history file for each kernel.When running kernels simultaneously (e.g. via multiprocessing) saving history a single SQLite file can result in database errors, so using
:memory:is recommended in non-interactive contexts.- ExecutePreprocessor.kernel_manager_class : Type
Default:
'builtins.object'The kernel manager class to use.
- ExecutePreprocessor.kernel_name : Unicode
Default:
''Name of kernel to use to execute the cells. If not set, use the kernel_spec embedded in the notebook.
- ExecutePreprocessor.raise_on_iopub_timeout : Bool
Default:
FalseIf
False(default), then the kernel will continue waiting for iopub messages until it receives a kernel idle message, or until a timeout occurs, at which point the currently executing cell will be skipped. IfTrue, then an error will be raised after the first timeout. This option generally does not need to be used, but may be useful in contexts where there is the possibility of executing notebooks with memory-consuming infinite loops.- ExecutePreprocessor.record_timing : Bool
Default:
TrueIf
True(default), then the execution timings of each cell will be stored in the metadata of the notebook.- ExecutePreprocessor.shell_timeout_interval : Int
Default:
5The time to wait (in seconds) for Shell output before retrying. This generally doesn’t need to be set, but if one needs to check for dead kernels at a faster rate this can help.
- ExecutePreprocessor.shutdown_kernel : any of
'graceful'``|’immediate’`` Default:
'graceful'If
graceful(default), then the kernel is given time to clean up after executing all cells, e.g., to execute itsatexithooks. Ifimmediate, then the kernel is signaled to immediately terminate.- ExecutePreprocessor.startup_timeout : Int
Default:
60The time to wait (in seconds) for the kernel to start. If kernel startup takes longer, a RuntimeError is raised.
- ExecutePreprocessor.store_widget_state : Bool
Default:
TrueIf
True(default), then the state of the Jupyter widgets created at the kernel will be stored in the metadata of the notebook.- ExecutePreprocessor.timeout : Int
Default:
NoneThe time to wait (in seconds) for output from executions. If a cell execution takes longer, a TimeoutError is raised.
Noneor-1will disable the timeout. Iftimeout_funcis set, it overridestimeout.- ExecutePreprocessor.timeout_func : Any
Default:
NoneA callable which, when given the cell source as input, returns the time to wait (in seconds) for output from cell executions. If a cell execution takes longer, a TimeoutError is raised.
Returning
Noneor-1will disable the timeout for the cell. Not settingtimeout_funcwill cause the preprocessor to default to using thetimeouttrait for all cells. Thetimeout_functrait overridestimeoutif it is notNone.- ExtractOutputPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ExtractOutputPreprocessor.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.
- ExtractOutputPreprocessor.enabled : Bool
Default:
FalseNo description
- ExtractOutputPreprocessor.extract_output_types : Set
Default:
{'application/pdf', 'image/jpeg', 'image/png', 'image/svg+xml'}No description
- ExtractOutputPreprocessor.output_filename_template : Unicode
Default:
'{unique_key}_{cell_index}_{index}{extension}'No description
- HighlightMagicsPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- HighlightMagicsPreprocessor.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.
- HighlightMagicsPreprocessor.enabled : Bool
Default:
FalseNo 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.
- LatexPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- LatexPreprocessor.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.
- LatexPreprocessor.enabled : Bool
Default:
FalseNo description
- LatexPreprocessor.style : Unicode
Default:
'default'Name of the pygments style to use
- RegexRemovePreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- RegexRemovePreprocessor.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.
- RegexRemovePreprocessor.enabled : Bool
Default:
FalseNo description
- RegexRemovePreprocessor.patterns : List
Default:
[]No description
- 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_filename}, and write a PDF to {to_filename}.
- SVG2PDFPreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- SVG2PDFPreprocessor.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.
- SVG2PDFPreprocessor.enabled : Bool
Default:
FalseNo description
- SVG2PDFPreprocessor.from_format : Unicode
Default:
''Format the converter accepts
- SVG2PDFPreprocessor.inkscape : Unicode
Default:
''The path to Inkscape, if necessary
- SVG2PDFPreprocessor.inkscape_version : Unicode
Default:
''The version of inkscape being used.
This affects how the conversion command is run.
- SVG2PDFPreprocessor.to_format : Unicode
Default:
''Format the converter writes
- TagRemovePreprocessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- TagRemovePreprocessor.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.
- TagRemovePreprocessor.enabled : Bool
Default:
FalseNo description
- TagRemovePreprocessor.remove_all_outputs_tags : Set
Default:
set()Tags indicating cells for which the outputs are to be removed,matches tags in
cell.metadata.tags.- TagRemovePreprocessor.remove_cell_tags : Set
Default:
set()Tags indicating which cells are to be removed,matches tags in
cell.metadata.tags.- TagRemovePreprocessor.remove_input_tags : Set
Default:
set()Tags indicating cells for which input is to be removed,matches tags in
cell.metadata.tags.- TagRemovePreprocessor.remove_metadata_fields : Set
Default:
{'collapsed', 'scrolled'}No description
- TagRemovePreprocessor.remove_single_output_tags : Set
Default:
set()Tags indicating which individual outputs are to be removed,matches output i tags in
cell.outputs[i].metadata.tags.
Postprocessor Options¶
- PostProcessorBase.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- PostProcessorBase.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.
- ServePostProcessor.browser : Unicode
Default:
''Specify what browser should be used to open slides. See https://docs.python.org/3/library/webbrowser.html#webbrowser.register to see how keys are mapped to browser executables. If not specified, the default browser will be determined by the
webbrowserstandard library module, which allows setting of the BROWSER environment variable to override it.- ServePostProcessor.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ServePostProcessor.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.
- ServePostProcessor.ip : Unicode
Default:
'127.0.0.1'The IP address to listen on.
- ServePostProcessor.open_in_browser : Bool
Default:
TrueShould the browser be opened automatically?
- ServePostProcessor.port : Int
Default:
8000port for the server to listen on.
- ServePostProcessor.reveal_cdn : Unicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.5.0'URL for reveal.js CDN.
- ServePostProcessor.reveal_prefix : Unicode
Default:
'reveal.js'URL prefix for reveal.js
Other Options¶
- NbConvertBase.default_language : Unicode
Default:
'ipython'Deprecated default highlight language as of 5.0, 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.
- NotebookClient.allow_errors : Bool
Default:
FalseIf
False(default), when a cell raises an error the execution is stopped and aCellExecutionErroris raised. IfTrue, execution errors are ignored and the execution is continued until the end of the notebook. Output from exceptions is included in the cell output in both cases.- NotebookClient.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.
- NotebookClient.extra_arguments : List
Default:
[]No description
- NotebookClient.force_raise_errors : Bool
Default:
FalseIf False (default), errors from executing the notebook can be allowed with a
raises-exceptiontag on a single cell, or theallow_errorsconfigurable option for all cells. An allowed error will be recorded in notebook output, and execution will continue. If an error occurs when it is not explicitly allowed, aCellExecutionErrorwill be raised. If True,CellExecutionErrorwill be raised for any error that occurs while executing the notebook. This overrides both theallow_errorsoption and theraises-exceptioncell tag.- NotebookClient.interrupt_on_timeout : Bool
Default:
FalseIf execution of a cell times out, interrupt the kernel and continue executing other cells rather than throwing an error and stopping.
- NotebookClient.iopub_timeout : Int
Default:
4The time to wait (in seconds) for IOPub output. This generally doesn’t need to be set, but on some slow networks (such as CI systems) the default timeout might not be long enough to get all messages.
- NotebookClient.ipython_hist_file : Unicode
Default:
':memory:'Path to file to use for SQLite history database for an IPython kernel.
The specific value
:memory:(including the colon at both end but not the back ticks), avoids creating a history file. Otherwise, IPython will create a history file for each kernel.When running kernels simultaneously (e.g. via multiprocessing) saving history a single SQLite file can result in database errors, so using
:memory:is recommended in non-interactive contexts.- NotebookClient.kernel_manager_class : Type
Default:
'builtins.object'The kernel manager class to use.
- NotebookClient.kernel_name : Unicode
Default:
''Name of kernel to use to execute the cells. If not set, use the kernel_spec embedded in the notebook.
- NotebookClient.raise_on_iopub_timeout : Bool
Default:
FalseIf
False(default), then the kernel will continue waiting for iopub messages until it receives a kernel idle message, or until a timeout occurs, at which point the currently executing cell will be skipped. IfTrue, then an error will be raised after the first timeout. This option generally does not need to be used, but may be useful in contexts where there is the possibility of executing notebooks with memory-consuming infinite loops.- NotebookClient.record_timing : Bool
Default:
TrueIf
True(default), then the execution timings of each cell will be stored in the metadata of the notebook.- NotebookClient.shell_timeout_interval : Int
Default:
5The time to wait (in seconds) for Shell output before retrying. This generally doesn’t need to be set, but if one needs to check for dead kernels at a faster rate this can help.
- NotebookClient.shutdown_kernel : any of
'graceful'``|’immediate’`` Default:
'graceful'If
graceful(default), then the kernel is given time to clean up after executing all cells, e.g., to execute itsatexithooks. Ifimmediate, then the kernel is signaled to immediately terminate.- NotebookClient.startup_timeout : Int
Default:
60The time to wait (in seconds) for the kernel to start. If kernel startup takes longer, a RuntimeError is raised.
- NotebookClient.store_widget_state : Bool
Default:
TrueIf
True(default), then the state of the Jupyter widgets created at the kernel will be stored in the metadata of the notebook.- NotebookClient.timeout : Int
Default:
NoneThe time to wait (in seconds) for output from executions. If a cell execution takes longer, a TimeoutError is raised.
Noneor-1will disable the timeout. Iftimeout_funcis set, it overridestimeout.- NotebookClient.timeout_func : Any
Default:
NoneA callable which, when given the cell source as input, returns the time to wait (in seconds) for output from cell executions. If a cell execution takes longer, a TimeoutError is raised.
Returning
Noneor-1will disable the timeout for the cell. Not settingtimeout_funcwill cause the preprocessor to default to using thetimeouttrait for all cells. Thetimeout_functrait overridestimeoutif it is notNone.