class documentation
class APIBuilder: (source)
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 | |
project | The name of the package for which to generate documentation. |
project | The location (probably an HTTP URL) of the project on the web. |
source | The location (probably an HTTP URL) of the root of the source browser for the project. |
packageFilePath | The path to the top-level of the package named by projectName. |
outputFilePath | An existing directory to which the generated API documentation will be written. |