Module DocXMLRPCServer :: Class ServerHTMLDoc

Class ServerHTMLDoc

pydoc.Doc --+    
            |    
pydoc.HTMLDoc --+
                |
               ServerHTMLDoc

Class used to generate pydoc HTML document for a server

Instance Methods

[hide private]

markup(self, text, escape=None, funcs={}, classes={}, methods={})
Mark up some plain text, given a context of symbols to look for.

docroutine(self, object, name=None, mod=None, funcs={}, classes={}, methods={}, cl=None)
Produce HTML documentation for a function or method object.

docserver(self, server_name, package_documentation, methods)
Produce HTML documentation for an XML-RPC server.

Inherited from pydoc.HTMLDoc: bigsection, classlink, docclass, docdata, docmodule, docother, docproperty, escape, formattree, formatvalue, grey, heading, index, modpkglink, modulelink, multicolumn, namelink, page, preformat, repr, section

Inherited from pydoc.HTMLDoc (private): _docdescriptor

Inherited from pydoc.Doc: document, fail, getdocloc

Class Variables

[hide private]

Inherited from pydoc.HTMLDoc (private): _repr_instance

Method Details

[hide private]

markup(self, text, escape=None, funcs=`{}`, classes=`{}`, methods=`{}`)

Mark up some plain text, given a context of symbols to look for. Each context dictionary maps object names to anchor names.

Overrides: pydoc.HTMLDoc.markup

docroutine(self, object, name=None, mod=None, funcs=`{}`, classes=`{}`, methods=`{}`, cl=None)

Produce HTML documentation for a function or method object.

Overrides: pydoc.Doc.fail

Class ServerHTMLDoc

markup(self, text, escape=None, funcs={}, classes={}, methods={})

docroutine(self, object, name=None, mod=None, funcs={}, classes={}, methods={}, cl=None)

markup(self, text, escape=None, funcs=`{}`, classes=`{}`, methods=`{}`)

docroutine(self, object, name=None, mod=None, funcs=`{}`, classes=`{}`, methods=`{}`, cl=None)