Doc Class Reference

Inheritance diagram for Doc:

Public Member Functions
def	document
def	fail

Static Public Attributes
	docmodule = fail

Detailed Description

Definition at line 263 of file pydoc.py.

Member Function Documentation

def document	(		self,
			object,
			name = None,
			args
	)

Generate documentation for an object.

Definition at line 264 of file pydoc.py.

References HTMLDoc.docclass(), TextDoc.docclass(), Doc.docmodule, HTMLDoc.docother(), TextDoc.docother(), HTMLDoc.docroutine(), TextDoc.docroutine(), inspect.isclass(), inspect.ismodule(), and inspect.isroutine().

    def document(self, object, name=None, *args):
        """Generate documentation for an object."""
        args = (object, name) + args
        if inspect.ismodule(object): return apply(self.docmodule, args)
        if inspect.isclass(object): return apply(self.docclass, args)
        if inspect.isroutine(object): return apply(self.docroutine, args)
        return apply(self.docother, args)