Table of Contents

Class: TextFormatter HappyDoc-r0_7_1/formatter/formatter_textfile.py

Output documentation in plain ASCII text format.

Base Classes   
formatter_file.FileBasedFormatter
Methods   
dedent
descriptiveListFooter
descriptiveListHeader
descriptiveListItem
dividingLine
getFilenameExtension
getInternalReference
getLocalReference
getNamedReference
getPythonReference
getReference
getRootNodeName
indent
itemFooter
itemHeader
listFooter
listHeader
listItem
popSectionLevel
pushSectionLevel
sectionFooter
sectionHeader
writeExceptionListForFunction
writeText
  dedent 
dedent ( self,  output )

  descriptiveListFooter 
descriptiveListFooter ( self,  output )

  descriptiveListHeader 
descriptiveListHeader (
        self,
        output,
        title,
        )

  descriptiveListItem 
descriptiveListItem (
        self,
        output,
        item,
        description,
        )

  dividingLine 
dividingLine (
        self,
        output,
        fill='-',
        span=80,
        )

Output a sectional dividing line.

Parameters:

output

destination for written output

fill="-"

character to use to draw the line

span=80

width of line to draw

  getFilenameExtension 
getFilenameExtension ( self )

Returns the extension to use when creating files for this formatter.

  getInternalReference 
getInternalReference ( self,  infoSource )

  getLocalReference 
getLocalReference ( self,  infoSource )

  getNamedReference 
getNamedReference (
        self,
        infoSource,
        name,
        relativeSource,
        )

  getPythonReference 
getPythonReference ( self,  moduleName )

return http://www.python.org/doc/current/lib/module-%(moduleName)s.html % locals()

  getReference 
getReference (
        self,
        infoSource,
        relativeSource,
        )

  getRootNodeName 
getRootNodeName ( self )

Return the name of the root node for the documentation tree.

  indent 
indent ( self,  output )

  itemFooter 
itemFooter ( self,  output )

  itemHeader 
itemHeader (
        self,
        output,
        infoObject,
        )

  listFooter 
listFooter ( self,  output )

  listHeader 
listHeader (
        self,
        output,
        title=None,
        allowMultiColumn=1,
        )

else: self.writeRaw(\n-- ** --\n\n, output)

  listItem 
listItem (
        self,
        output,
        text,
        )

  popSectionLevel 
popSectionLevel ( self,  output )

  pushSectionLevel 
pushSectionLevel ( self,  output )

  sectionFooter 
sectionFooter ( self,  output )

  sectionHeader 
sectionHeader (
        self,
        output,
        title,
        )

  writeExceptionListForFunction 
writeExceptionListForFunction (
        self,
        output,
        function,
        listHeader,
        )

Write the list of exceptions raised by a function.

Parameters

output

Where to write.

function

FunctionInfo from parseinfo module.

listHeader

Header for list being generated.

  writeText 
writeText (
        self,
        text,
        output,
        )

Output the text string to the information source.


Table of Contents

This document was automatically generated on Sat Sep 9 20:27:32 2000 by HappyDoc version r0_7_1