Formatter which produces plain ASCII text.
Parameters
- filenamePrefix
- A prefix to append to the base names of files
and directories being created. This is
useful for situations where the names which
would be automatically generated might cause
a name clash or conflict.
|
Base Classes
|
|
happydoclib.formatter.fileformatterbase.FileBasedFormatter
|
|
Methods
|
|
|
|
|
|
comment
|
comment (
self,
text,
output,
)
|
|
|
dedent
|
dedent ( self, output )
|
|
|
descriptiveListFooter
|
descriptiveListFooter ( self, output )
|
|
|
descriptiveListHeader
|
descriptiveListHeader (
self,
output,
title,
)
|
|
|
descriptiveListItem
|
descriptiveListItem (
self,
output,
item,
description,
descriptionFormat,
)
|
|
|
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
|
|
|
formatCode
|
formatCode (
self,
text,
textFormat,
)
|
|
|
formatKeyword
|
formatKeyword ( self, text )
|
|
|
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 )
|
|
|
getReference
|
getReference (
self,
infoSource,
relativeSource,
name=None,
)
|
|
|
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,
)
|
|
|
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,
textFormat,
quote=1,
)
Output the text string to the information source.
|
|