module helpgen.notebook_exporter

Short summary

module pyquickhelper.helpgen.notebook_exporter

Customer notebook exporters.

source on GitHub

Classes

class	truncated documentation
UpgradedRSTExporter	Exports rst documents. Overwrites RSTExporter. …

Functions

function	truncated documentation
convert_pandoc_rst	Overwrites convert_pandoc.
process_raw_html	Replaces the output of add_menu_notebook …

Properties

property	truncated documentation
cross_validation_lock	A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …
default_config
environment
template

Methods

method	truncated documentation
__init__	Overwrites the extra loaders to get the right template.
default_filters	Overrides in subclasses to provide extra filters. This should return an iterable of 2-tuples: (name, class-or-function). …

Documentation

Customer notebook exporters.

source on GitHub

class pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter(**kwargs: Any)

Bases: RSTExporter

Exports rst documents. Overwrites RSTExporter.

• It replaces `convert_pandoc <https://github.com/jupyter/

nbconvert/blob/master/nbconvert/filters/pandoc.py>`_

by convert_pandoc_rst.

• It converts svg into png if possible, see process_raw_html.

• It replaces some known javascript. The output of function add_menu_notebook is replaced by .. contents::.

It extends the template rst.tpl. New template is rst_modified.tpl. It follows the hints given at Programatically creating templates.

jyquickhelper should add a string highly recognizable when adding a menu.

source on GitHub

Overwrites the extra loaders to get the right template.

source on GitHub

__init__(*args, **kwargs)

Overwrites the extra loaders to get the right template.

source on GitHub

_all_trait_default_generators: t.Dict[str, t.Any] = {'_preprocessors': <bound method TraitType.default of <traitlets.traitlets.List object>>, 'config': <bound method TraitType.default of <traitlets.traitlets.Instance object>>, 'default_preprocessors': <bound method TraitType.default of <traitlets.traitlets.List object>>, 'enable_async': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'enabled': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_code_cell': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_input': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_input_prompt': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_markdown': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_output': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_output_prompt': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_output_stdin': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_raw': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'exclude_unknown': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'extra_loaders': <bound method TraitType.default of <traitlets.traitlets.List object>>, 'extra_template_basedirs': <traitlets.traitlets.DefaultHandler object>, 'extra_template_paths': <bound method TraitType.default of <traitlets.traitlets.List object>>, 'file_extension': <traitlets.traitlets.DefaultHandler object>, 'filters': <bound method TraitType.default of <traitlets.traitlets.Dict object>>, 'log': <traitlets.traitlets.DefaultHandler object>, 'optimistic_validation': <bound method TraitType.default of <traitlets.traitlets.Bool object>>, 'parent': <bound method TraitType.default of <traitlets.traitlets.Instance object>>, 'preprocessors': <bound method TraitType.default of <traitlets.traitlets.List object>>, 'raw_mimetypes': <traitlets.traitlets.DefaultHandler object>, 'raw_template': <bound method TraitType.default of <traitlets.traitlets.Unicode object>>, 'template_data_paths': <bound method TraitType.default of <traitlets.traitlets.List object>>, 'template_extension': <traitlets.traitlets.DefaultHandler object>, 'template_file': <traitlets.traitlets.DefaultHandler object>, 'template_name': <traitlets.traitlets.DefaultHandler object>, 'template_paths': <traitlets.traitlets.DefaultHandler object>}

_descriptors = [<traitlets.traitlets.ObserveHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.List object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.ObserveHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.ObserveHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.ValidateHandler object>, <traitlets.traitlets.DefaultHandler object>, <traitlets.traitlets.ValidateHandler object>, <traitlets.traitlets.Instance object>, <traitlets.traitlets.List object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.List object>, <traitlets.traitlets.List object>, <traitlets.traitlets.List object>, <nbconvert.exporters.exporter.FilenameExtension object>, <traitlets.traitlets.Dict object>, <traitlets.traitlets.Any object>, <traitlets.traitlets.Bool object>, <traitlets.traitlets.Instance object>, <traitlets.traitlets.List object>, <traitlets.traitlets.List object>, <traitlets.traitlets.Unicode object>, <traitlets.traitlets.List object>, <traitlets.traitlets.Unicode object>, <traitlets.traitlets.Unicode object>, <traitlets.traitlets.Unicode object>, <traitlets.traitlets.List object>]

_file_extension_default

_instance_inits = [<bound method ObserveHandler.instance_init of <traitlets.traitlets.ObserveHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method ObserveHandler.instance_init of <traitlets.traitlets.ObserveHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method ObserveHandler.instance_init of <traitlets.traitlets.ObserveHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method ValidateHandler.instance_init of <traitlets.traitlets.ValidateHandler object>>, <bound method BaseDescriptor.instance_init of <traitlets.traitlets.DefaultHandler object>>, <bound method ValidateHandler.instance_init of <traitlets.traitlets.ValidateHandler object>>, <bound method Instance.instance_init of <traitlets.traitlets.Instance object>>, <bound method Instance.instance_init of <traitlets.traitlets.Instance object>>]

_static_immutable_initial_values: t.Dict[str, t.Any] = {'enable_async': False, 'enabled': True, 'exclude_code_cell': False, 'exclude_input': False, 'exclude_input_prompt': False, 'exclude_markdown': False, 'exclude_output': False, 'exclude_output_prompt': False, 'exclude_output_stdin': True, 'exclude_raw': False, 'exclude_unknown': False, 'optimistic_validation': False, 'parent': None, 'raw_template': ''}

_template_file_default

_template_name_default

_trait_default_generators = {'file_extension': <traitlets.traitlets.DefaultHandler object>, 'template_file': <traitlets.traitlets.DefaultHandler object>, 'template_name': <traitlets.traitlets.DefaultHandler object>}

_traits: t.Dict[str, t.Any] = {'_preprocessors': <traitlets.traitlets.List object>, 'config': <traitlets.traitlets.Instance object>, 'default_preprocessors': <traitlets.traitlets.List object>, 'enable_async': <traitlets.traitlets.Bool object>, 'enabled': <traitlets.traitlets.Bool object>, 'exclude_code_cell': <traitlets.traitlets.Bool object>, 'exclude_input': <traitlets.traitlets.Bool object>, 'exclude_input_prompt': <traitlets.traitlets.Bool object>, 'exclude_markdown': <traitlets.traitlets.Bool object>, 'exclude_output': <traitlets.traitlets.Bool object>, 'exclude_output_prompt': <traitlets.traitlets.Bool object>, 'exclude_output_stdin': <traitlets.traitlets.Bool object>, 'exclude_raw': <traitlets.traitlets.Bool object>, 'exclude_unknown': <traitlets.traitlets.Bool object>, 'extra_loaders': <traitlets.traitlets.List object>, 'extra_template_basedirs': <traitlets.traitlets.List object>, 'extra_template_paths': <traitlets.traitlets.List object>, 'file_extension': <nbconvert.exporters.exporter.FilenameExtension object>, 'filters': <traitlets.traitlets.Dict object>, 'log': <traitlets.traitlets.Any object>, 'optimistic_validation': <traitlets.traitlets.Bool object>, 'parent': <traitlets.traitlets.Instance object>, 'preprocessors': <traitlets.traitlets.List object>, 'raw_mimetypes': <traitlets.traitlets.List object>, 'raw_template': <traitlets.traitlets.Unicode object>, 'template_data_paths': <traitlets.traitlets.List object>, 'template_extension': <traitlets.traitlets.Unicode object>, 'template_file': <traitlets.traitlets.Unicode object>, 'template_name': <traitlets.traitlets.Unicode object>, 'template_paths': <traitlets.traitlets.List object>}

default_filters()

Overrides in subclasses to provide extra filters.

This should return an iterable of 2-tuples: (name, class-or-function). You should call the method on the parent class and include the filters it provides.

If a name is repeated, the last filter provided wins. Filters from user-supplied config win over filters provided by classes.

source on GitHub

pyquickhelper.helpgen.notebook_exporter.convert_pandoc_rst(source, from_format, to_format, extra_args=None)

Overwrites convert_pandoc.

Parameters:

• source – string to convert

• from_format – from format

• to_format – to format

• extra_args – extra arguments

Returns:

results

source on GitHub

pyquickhelper.helpgen.notebook_exporter.process_raw_html(source, extra_args=None)

Replaces the output of add_menu_notebook by:

.. contents::
    :local:

source on GitHub