twisted.python._release.BookBuilder : API documentation

Method	run	Execute a command in a child process and return the output.
Method	buildTeX	Build LaTex files for lore input files in the given directory.
Method	buildPDF	Build a PDF from the given a LaTeX book document.
Method	build	Build a PDF book from the given TeX book definition and directories containing lore inputs.

Inherited from LoreBuilderMixin:

Method

lore

Run lore with the given arguments.

def run(self, command): (source)

Execute a command in a child process and return the output.

@type command C{str}
@param command: The shell command to run.

@raise L{RuntimeError}: If the child process exits with an error.

def buildTeX(self, howtoDir): (source)

Build LaTex files for lore input files in the given directory.

Input files ending in .xhtml will be considered. Output will written as .tex files.

Parameters	howtoDir	A directory containing lore input files. (type: `FilePath` )
Raises	ValueError	If `howtoDir` does not exist.

def buildPDF(self, bookPath, inputDirectory, outputPath): (source)

Build a PDF from the given a LaTeX book document.

Parameters	bookPath	The location of a LaTeX document defining a book. (type: `FilePath` )
	inputDirectory	The directory which the inputs of the book are relative to. (type: `FilePath` )
	outputPath	The location to which to write the resulting book. (type: `FilePath` )

def build(self, baseDirectory, inputDirectories, bookPath, outputPath): (source)

Build a PDF book from the given TeX book definition and directories containing lore inputs.

Parameters	baseDirectory	The directory which the inputs of the book are relative to. (type: `FilePath` )
	inputDirectories	The paths which contain lore inputs to be converted to LaTeX. (type: `list` of `FilePath` )
	bookPath	The location of a LaTeX document defining a book. (type: `FilePath` )
	outputPath	The location to which to write the resulting book. (type: `FilePath` )

t.p._.BookBuilder(LoreBuilderMixin) : class documentation