ipypublish.postprocessors.sphinx module

class ipypublish.postprocessors.sphinx.RunSphinx(*args, **kwargs)[source]

Bases: ipypublish.postprocessors.base.IPyPostProcessor

run sphinx to create an html output

property allowed_mimetypes

override in subclasses

return a list of allowed mime types if None, then all are allowed

Text based mime-types include: text/plain, text/latex, text/restructuredtext, text/html, text/x-python, application/json, text/markdown, text/asciidoc, text/yaml

conf_kwargs

An instance of a Python dict.

property logger_name

override in subclass

nitpick

A boolean (True, False) trait.

numbered

A boolean (True, False) trait.

open_in_browser

A boolean (True, False) trait.

override_defaults

A boolean (True, False) trait.

prompt_style

A trait for unicode strings.

property requires_path

override in subclasses

whether the prostprocessor requires the supplied filepath to have an existing parent directory

if True and filepath is None, will raise an IOError, otherwise, will try to make the directory if it doesn’t exist

run_postprocess(stream, mimetype, filepath, resources)[source]

should not be called directly override in sub-class

Parameters
  • stream (str) – the main file contents

  • filepath (None or pathlib.Path) – the path to the output file

  • resources (dict) – a resources dict, output from exporter.from_notebook_node

Returns

show_prompts

A boolean (True, False) trait.