twisted.python._release.APIBuilder

class documentation

class APIBuilder: (source)

View In Hierarchy

Generate API documentation from source files using pydoctor. This requires pydoctor to be installed and usable.
Method build Call pydoctor's entry point with options which will generate HTML documentation for the specified package's API.
def build(self, projectName, projectURL, sourceURL, packagePath, outputPath): (source)
Call pydoctor's entry point with options which will generate HTML documentation for the specified package's API.
Parameters
project​Name:strThe name of the package for which to generate documentation.
project​URL:strThe location (probably an HTTP URL) of the project on the web.
source​URL:strThe location (probably an HTTP URL) of the root of the source browser for the project.
package​Path:FilePathThe path to the top-level of the package named by projectName.
output​Path:FilePathAn existing directory to which the generated API documentation will be written.