twisted.python._release.APIBuilder(object) class documentationtwisted.python._release
View 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. |
Call pydoctor's entry point with options which will generate HTML documentation for the specified package's API.
| Parameters | projectName | The name of the package for which to generate documentation. (type: str) |
| projectURL | The location (probably an HTTP URL) of the project on the web. (type: str) | |
| sourceURL | The location (probably an HTTP URL) of the root of the source browser for the project. (type: str) | |
| packagePath | The path to the top-level of the package named by projectName. (type: FilePath) | |
| outputPath | An existing directory to which the generated API documentation will be written. (type: FilePath) |