twisted.python._release.DocBuilder : API documentation

Method	build	Build the documentation in `docDir` with Lore.
Method	getLinkrel	Calculate a value appropriate for Lore's --linkrel option.

Inherited from LoreBuilderMixin:

Method

lore

Run lore with the given arguments.

def build(self, version, resourceDir, docDir, template, deleteInput=False): (source)

Build the documentation in docDir with Lore.

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

Parameters	version	the version of the documentation to pass to lore. (type: `str` )
	resourceDir	The directory which contains the toplevel index and stylesheet file for this section of documentation. (type: `twisted.python.filepath.FilePath` )
	docDir	The directory of the documentation. (type: `twisted.python.filepath.FilePath` )
	template	The template used to generate the documentation. (type: `twisted.python.filepath.FilePath` )
	deleteInput	If True, the input documents will be deleted after their output is generated. (type: `bool` )
Raises	NoDocumentsFound	When there are no .xhtml files in the given `docDir`.

def getLinkrel(self, resourceDir, docDir): (source)

Calculate a value appropriate for Lore's --linkrel option.

Lore's --linkrel option defines how to 'find' documents that are linked to from TEMPLATE files (NOT document bodies). That is, it's a prefix for links ('a' and 'link') in the template.

Parameters	resourceDir	The directory which contains the toplevel index and stylesheet file for this section of documentation. (type: `twisted.python.filepath.FilePath` )
	docDir	The directory containing documents that must link to `resourceDir`. (type: `twisted.python.filepath.FilePath` )

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