The DocXMLRPCServer module extends the classes found in SimpleXMLRPCServer to serve HTML documentation in response to HTTP
GET requests. Servers can either be free standing, using DocXMLRPCServer, or embedded in a CGI environment, using DocCGIXMLRPCRequestHandler.

class DocXMLRPCServer( addr[, requestHandler[, logRequests]]) 

Create a new server instance. The requestHandler parameter should be a factory for request handler instances; it defaults to DocXMLRPCRequestHandler. The addr and requestHandler parameters are passed to the SocketServer.TCPServer constructor. If logRequests is true (the default), requests will be logged; setting this parameter to false will turn off logging. This class provides methods for registration of functions that can be called by the XML-RPC protocol and methods that control documentation generation.

class DocCGIXMLRPCRequestHandler( ) 

Create a new instance to handle XML-RPC requests in a CGI environment.

class DocXMLRPCRequestHandler( ) 

Create a new request handler instance. This request handler supports XML-RPC POST requests, documentation GET requests, and modifies logging so that the logRequests parameter to the DocXMLRPCServer constructor parameter is honored. 

--

DocXMLRPCServer Objects 

The DocXMLRPCServer class is derived from SimpleXMLRPCServer.SimpleXMLRPCServer and provides a means of creating self-documenting, stand alone XML-RPC servers. HTTP POST requests are handled as XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style HTML documentation. This allows a server to provide its own web-based documentation.

set_server_title(server_title)

Sets the title used in the generated HTML documentation. This title will be used inside the HTML "title" element.

set_server_name(server_name)

Sets the name used in the generated HTML documentation. This name will appear at the top of the generated documentation inside a "h1" element.


set_server_documentation(server_documentation)

Sets the description used in the generated HTML documentation. This description will appear as a paragraph, below the server name, in the documentation.

--

DocCGIXMLRPCRequestHandler objects

The DocCGIXMLRPCRequestHandler class is derived from SimpleXMLRPCServer.CGIXMLRPCRequestHandler and provides a means of creating self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled as XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style HTML documentation. This allows a server to provide its own web-based documentation.

set_server_title(server_title)

Sets the title used in the generated HTML documentation. This title will be used inside the HTML "title" element.

set_server_name(server_name)

Sets the name used in the generated HTML documentation. This name will appear at the top of the generated documentation inside a "h1" element.


set_server_documentation(server_documentation)

Sets the description used in the generated HTML documentation. This description will appear as a paragraph, below the server name, in the documentation.