__init__ (
        self,
        docSet,
        pageBackgroundColor='#ffffff',
        levelOneHeadingBackgroundColor='#88bbee',
        levelOneHeadingForegroundColor='#000000',
        levelTwoHeadingBackgroundColor='#99ccff',
        levelTwoHeadingForegroundColor='#000000',
        codeForegroundColor='#000088',
        docsetTitle=None,
        dateStampFiles=1,
        htmlQuoteText=1,
        compactHTML=0,
        debug=0,
        **configuration,
        )

Initialize the HTMLTableFormatter.

Parameters

docSet

the DocSet instance containing global cross-reference information

**configuration

additional, optional, configuration values

_fixReference (
        self,
        reference,
        sep=os.sep,
        )

All HTML links use the '/ separator, so here the current platform separator needs to be replaced with the /'.

_writeListItems (
        self,
        items,
        output,
        )

Format and output the items as list elements.

closeOutput ( self,  output )

Close the output handle.

comment (
        self,
        text,
        output,
        )

Output text as a comment.

dedent ( self,  output )

End an indented section.

descriptiveListFooter ( self,  output )

Write the closing footer for a descriptive list to the output.

descriptiveListHeader (
        self,
        output,
        title,
        )

Write the title as the heading for a descriptive list to the output.

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

Format and write the item and description for a descriptive list to the output.

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

Write a sectional dividing line made up of repeated fill characters to the output.

fileFooter ( self,  output )

Write the formatting for a file footer to the open file.

fileHeader (
        self,
        title1,
        title2=' ',
        output=None,
        )

Write the formatting for a file header to the open file.

formatCode (
        self,
        text,
        textFormat,
        )

Format text as source code and return the new string.

formatKeyword ( self,  text )

Format text as a keyword and return the new string.

genericSectionFooter ( self,  output )

Write a general purpose section closing footer to the output.

genericSectionHeader (
        self,
        output,
        title1,
        title2,
        anchor=None,
        )

Output a standard nested table chunk which represents a section header.

The output looks something like this:

            |--------|---------------------------|
            | title1 | title2                    |
            |        |---------------------------|
            |        | section text goes here
            |--------|

Parameters

output

destination for written output

title1

title to be placed in left column

title2

title to be placed on top of right column

anchor

optional, anchor to which a reference can point to find this section

getFilenameExtension ( self )

Returns the extension for creating output files.

getInternalReference ( self,  infoSource )

Returns a reference to infoSource within the current document.

getNamedReference (
        self,
        infoSource,
        name,
        relativeSource,
        )

Returns a reference to name within the documentation for infoSource from relativeSource.

getPythonReference ( self,  moduleName )

Returns a reference to moduleName documentation on the Python.org documentation site.

getReference (
        self,
        infoSource,
        relativeSource,
        name=None,
        )

Returns a reference to the infoSource from relativeSource.

getRootLocation ( self,  output )

Return the root documentation node location relative to this output location.

getRootNodeName ( self )

Returns the name of the root node for documentation of this type.

htmlFooter ( self,  output )

Output a standard HTML footer used by all output files.

htmlHeader (
        self,
        title,
        subtitle,
        titleBg,
        titleFg,
        output,
        )

Output a standard HTML header used by all output files.

Parameters

title

title of the document

output

destination for written output

titleBg

background color for the title bar

titleFg

foreground color for text in the title bar

indent ( self,  output )

Begin an indented section.

itemFooter ( self,  output )

Write a section closing footer to the output.

itemHeader (
        self,
        output,
        infoObject,
        )

Write a section openning header for an infoObject to the output.

listFooter ( self,  output )

Write the closing footer for a list to the output.

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

Output title as a heading for a list. If allowMultiColumn is true, set up the list to have more than one column.

listItem (
        self,
        output,
        text,
        )

Format and output the text as a list element.

openOutput (
        self,
        name,
        title1,
        title2=' ',
        )

Open output destination using name with the title from title1. Write title2 as a secondary title to the new output.

popSectionLevel ( self,  output )

Pop a section level from the output stack.

pushSectionLevel ( self,  output )

Push a section level on the output stack.

sectionFooter ( self,  output )

Write a general purpose section closing footer to the output.

sectionHeader (
        self,
        output,
        title,
        )

Write a general purpose section openning title to the output.

writeCode (
        self,
        text,
        textFormat,
        output,
        )

Format and write the text to output as source code.

writeHTML (
        self,
        text,
        output,
        )

Remove extra white space in HTML before outputting.

writeText (
        self,
        text,
        output,
        textFormat,
        quote=1,
        )

Format and write the text to the output.

Arguments:

text

String to be written.

output

Stream to which text should be written.

textFormat

String identifying the format of text so the formatter can use a docstring converter to convert the body of text to the appropriate output format.

quote=1

Boolean option to control whether the text should be quoted to escape special characters.