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

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

A thing for building API documentation. See main.
Method buildAPIDocs Build the API documentation of Twisted, with our project policy.
Method main Build API documentation.
def buildAPIDocs(self, projectRoot, output): (source)
Build the API documentation of Twisted, with our project policy.
ParametersprojectRootA FilePath representing the root of the Twisted checkout.
outputA FilePath pointing to the desired output directory.
def main(self, args): (source)
Build API documentation.
ParametersargsThe command line arguments to process. This must contain two strings: the path to the root of the Twisted checkout, and a path to an output directory. (type: list of str)
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.