Disseminate

Document Processing

• Features: Basic
• Features: Advanced
• Quickstart

Installation

• MacOS (Homebrew)
• MacOS (Pip)
• Linux (Pip)

Markup Language

• Header
• Tags
• Macros

Projects

• Documents
• Templates

Interfaces

• Command-line

Development

• API Documentation
  • Attributes
  • Builders
  • Checkers
  • CLI
  • Contexts
  • Document
  • Formats
  • Label Manager
  • Paths
  • Server
  • Signals
  • Tags
  • Utilities
• Release Notes

• Index

XHtml2Epub

Builders for EPUB files

class disseminate.builders.xhtml2epub.XHtml2Epub(env, context, **kwargs)

Convert xhtml files to an epub v3 file.

Parameters

parameters, argsTuple[pathlib.Path, str, tuple, list]

The input parameters (dependencies), including filepaths for xhtml files, for the build. The parameters must include a ‘toc.xhtml’ file for the Table of Contents.

build(complete=False)

Run the build.

Parameters

completeOptional[bool]

If True, run the build until it has completed If False, start the build in the background.

Returns

statusstr

The current status of the build.

Note

• This function will run the sub-builders.

• Each builder is atomic

• When running a build, not all of the builders might be called in the first build–for example, subsequent builders may rely on the results of previous builds. For this reason, builders should be used in conjunction with an environment to make sure a set of builds are completed or the build complete=True should be used.

create_opf_builder(template_name='default/xhtml/content.opf')

Create a render builder for the content.opf file.

Parameters

template_nameOptional[str]

The name of the template to use for the content.opf.

filepath_dict_list(filepaths, suffix)

Create a list of dicts from the given filepaths

property parameters

The list of input parameters, including filepaths, needed for the build