module helpgen.notebook_exporter

Inheritance diagram of pyquickhelper.helpgen.notebook_exporter

Short summary

module pyquickhelper.helpgen.notebook_exporter

Customer notebook exporters.

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.

New in version 1.7.

source on GitHub

class pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter(*args, **kwargs)[source][source]

Bases: nbconvert.exporters.rst.RSTExporter

Exports rst documents. Overwrites RSTExporter.

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)[source][source]

Overwrites the extra loaders to get the right template.

source on GitHub

_template_file_default[source]
_trait_default_generators = {'template_file': <traitlets.traitlets.DefaultHandler object>}[source]
default_filters()[source][source]

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)[source][source]

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)[source][source]

Replaces the output of add_menu_notebook by:

.. contents::
    :local:

source on GitHub