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

Part of twisted.python._release View Source View In Hierarchy

Generate HTML documentation for projects.
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, apiBaseURL=None, deleteInput=False): (source)

Build the documentation in docDir with Lore.

Input files ending in .xhtml will be considered. Output will written as .html files.
Parametersversionthe version of the documentation to pass to lore. (type: str )
resourceDirThe directory which contains the toplevel index and stylesheet file for this section of documentation. (type: twisted.python.filepath.FilePath )
docDirThe directory of the documentation. (type: twisted.python.filepath.FilePath )
templateThe template used to generate the documentation. (type: twisted.python.filepath.FilePath )
apiBaseURLA format string which will be interpolated with the fully-qualified Python name for each API link. For example, to generate the Twisted 8.0.0 documentation, pass "http://twistedmatrix.com/documents/8.0.0/api/%s.html". (type: str or NoneType )
deleteInputIf True, the input documents will be deleted after their output is generated. (type: bool )
RaisesNoDocumentsFoundWhen 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.
ParametersresourceDirThe directory which contains the toplevel index and stylesheet file for this section of documentation. (type: twisted.python.filepath.FilePath )
docDirThe directory containing documents that must link to resourceDir. (type: twisted.python.filepath.FilePath )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.