t.p._.BuildDocsScript(object) : class documentation

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

A thing for building the main documentation. See main.
Method buildDocs Build the main documentation of Twisted, with our project policy.
Method main Build the main documentation.
def buildDocs(self, projectRoot, template): (source)
Build the main documentation of Twisted, with our project policy.
ParametersprojectRootA FilePath representing the root of the Twisted checkout. (type: FilePath)
templateA FilePath pointing to the template file that is used for the look and feel of the howto documentation. (type: FilePath)
def main(self, args): (source)
Build the main documentation.
ParametersargsThe command line arguments to process. This must contain two strings: the path to the root of the Twisted checkout and the path to the Twisted website template. (type: list of str)
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.