Module pydoc :: Class TextDoc
[hide private]
[frames] | no frames]

_ClassType TextDoc

Doc --+
      |
     TextDoc

Formatter class for text documentation.

Instance Methods [hide private]
 
repr(x)
 
bold(self, text)
Format a string in bold by overstriking.
 
indent(self, text, prefix=' ')
Indent text by prepending a given prefix to each line.
 
section(self, title, contents)
Format a section with a given heading.
 
formattree(self, tree, modname, parent=None, prefix='')
Render in text a class tree as returned by inspect.getclasstree().
 
docmodule(self, object, name=None, mod=None)
Produce text documentation for a given module object.
 
docclass(self, object, name=None, mod=None)
Produce text documentation for a given class object.
 
formatvalue(self, object)
Format an argument default value as text.
 
docroutine(self, object, name=None, mod=None, cl=None)
Produce text documentation for a function or method object.
 
_docdescriptor(self, name, value, mod)
 
docproperty(self, object, name=None, mod=None, cl=None)
Produce text documentation for a property.
 
docdata(self, object, name=None, mod=None, cl=None)
Produce text documentation for a data descriptor.
 
docother(self, object, name=None, mod=None, parent=None, maxlen=None, doc=None)
Produce text documentation for a data object.

Inherited from Doc: document, fail, getdocloc

Class Variables [hide private]
  _repr_instance = TextRepr()
Method Details [hide private]

docmodule(self, object, name=None, mod=None)

 

Produce text documentation for a given module object.

Overrides: Doc.fail

docclass(self, object, name=None, mod=None)

 

Produce text documentation for a given class object.

Overrides: Doc.fail

docroutine(self, object, name=None, mod=None, cl=None)

 

Produce text documentation for a function or method object.

Overrides: Doc.fail

docproperty(self, object, name=None, mod=None, cl=None)

 

Produce text documentation for a property.

Overrides: Doc.fail

docdata(self, object, name=None, mod=None, cl=None)

 

Produce text documentation for a data descriptor.

Overrides: Doc.fail

docother(self, object, name=None, mod=None, parent=None, maxlen=None, doc=None)

 

Produce text documentation for a data object.

Overrides: Doc.fail