Class XMLRPCDocGenerator

Known Subclasses:

Generates documentation for an XML-RPC server.

This class is designed as mix-in and should not be constructed directly.

Instance Methods

[hide private]

__init__(self)

set_server_title(self, server_title)
Set the HTML title of the generated server documentation

set_server_name(self, server_name)
Set the name of the generated HTML server documentation

set_server_documentation(self, server_documentation)
Set the documentation string for the entire server.

generate_html_documentation(self)
generate_html_documentation() => html documentation for the server

Method Details

[hide private]

generate_html_documentation(self)

generate_html_documentation() => html documentation for the server

Generates HTML documentation for the server using introspection for installed functions and instances that do not implement the _dispatch method. Alternatively, instances can choose to implement the _get_method_argstring(method_name) method to provide the argument string used in the documentation and the _methodHelp(method_name) method to provide the help text used in the documentation.