class documentation

class twisted.python._release.BuildAPIDocsScript: (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 20.12.1 at 2021-02-28 19:53:36.