HappyDoc Generated Documentation Class: MultiHTMLFileDocSet

HappyDoc3-r3_1 / happydoclib / docset / docset_MultiHTMLFile.py / MultiHTMLFileDocSet 

Documentation set written to multiple HTML files.

Base Classes   

MultiHTMLFileDocSet
  base.MultiFileDocSet
    DocSet

Methods   
  getOutputFilenameForSymbol 
getOutputFilenameForSymbol (
        self,
        packageTreeNode,
        symbolName,
        includePath=1,
        )

Returns a filename where documentation for symbolName should be written.

The filename will be in the output directory, possibly in a subdirectory based on the path from the input root to the input file.

  _getBaseClassTree 
_getBaseClassTree (
        self,
        linkSource,
        moduleTreeNode,
        classTreeNode,
        className,
        )
  writeBreadcrumbs 
writeBreadcrumbs (
        self,
        output,
        packageTreeNode,
        )

Write breadcrumb links from the root down to packageTreeNode.

  writeClassListForModule 
writeClassListForModule (
        self,
        output,
        packageTreeNode,
        )

Write descriptions of all of the classes to the output stream.

  processPythonFile 
processPythonFile ( self,  packageTreeNode )

Handler for text/x-python nodes.

  writeOneFunctionToOutput 
writeOneFunctionToOutput (
        self,
        output,
        packageTreeNode,
        functionInfo,
        )

Write all of the information for one function to the output stream.

  writeImportWithFrom 
writeImportWithFrom (
        self,
        output,
        pacakgeTreeNode,
        moduleReference,
        symbolReferences,
        )

Write an import statement: from X import Y

  writeFunctionParameter 
writeFunctionParameter (
        self,
        output,
        name,
        info,
        )

Write a function parameter to the output.

No indenting or formatting is performed. The output looks like:

            name

or

name=default

Parameters:
name
name of the parameter
info
tuple of (default_specified, default_value, default_value_type) concerning the default value of the parameter
output
destination for written output
  writeSectionFooter 
writeSectionFooter ( self,  output )

Generate the text and styles to close the current section.

  writeTree 
writeTree (
        self,
        output,
        treeRoot,
        indent=0,
        )
  processPythonClass 
processPythonClass ( self,  packageTreeNode )

Writes information about classes in this module to the output stream.

  writePythonFileImportsToOutput 
writePythonFileImportsToOutput (
        self,
        output,
        packageTreeNode,
        )

Writes the list of imported modules for the packageTreeNode.

  writeFileHeader 
writeFileHeader (
        self,
        output,
        packageTreeNode,
        title='',
        subtitle='',
        )

Given an open output stream, write a header using the title and subtitle.

  writeFunctionSignature 
writeFunctionSignature (
        self,
        output,
        packageTreeNode,
        function,
        )

Write the function signature for function to output.

Parameters
output
Where to write.
pacakgeTreeNode
The part of the input we are processing.
function
Instance of FunctionInfo from parseinfo module.
  writeExceptionListForFunction 
writeExceptionListForFunction (
        self,
        output,
        function,
        )

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.
  _getAnchorTagForPackageTreeNode 
_getAnchorTagForPackageTreeNode (
        self,
        source,
        destination,
        title=None,
        internalTarget=None,
        )

Return a anchor tag to be included in the documentation of source that points to the destination.

  writeFileFooter 
writeFileFooter ( self,  output )

Given an open output stream, write a footer using the title and subtitle.

  writePythonFileInfoToOutput 
writePythonFileInfoToOutput (
        self,
        output,
        packageTreeNode,
        )

Writes parts of the Python file information to the output stream.

  writeDescriptiveList 
writeDescriptiveList (
        self,
        output,
        descriptiveList,
        )

Write a list including descriptions.

Arguments
output
Open output stream.
descriptiveList
Sequence of (name, description, description_format) values to be included in the output list.
  getOutputFilenameForPackageTreeNode 
getOutputFilenameForPackageTreeNode (
        self,
        packageTreeNode,
        includePath=1,
        )

Returns a filename where documentation for packageTreeNode should be written.

The filename will be in the output directory, possibly in a subdirectory based on the path from the input root to the input file.

For example:

          input_directory  : /foo/input
          containing       : /foo/input/bar.py
          output_directory : /foo/output

          results in       : /foo/output/input/bar.py

  pushSectionLevel 
pushSectionLevel (
        self,
        output,
        title,
        subtitle='',
        anchor='',
        )

Increase the section level.

Generate the text and styles to begin a new section one deeper than the previous level.

  writeFunctionsToOutput 
writeFunctionsToOutput (
        self,
        output,
        packageTreeNode,
        )

Writes information about functions in this module to the output stream.

  writeOneClassToOutput 
writeOneClassToOutput (
        self,
        output,
        packageTreeNode,
        )

Writes information about one class to the output stream.

  _writeBreadcrumbs 
_writeBreadcrumbs (
        self,
        output,
        sourceNode,
        breadcrumbNode,
        )

Write breadcrumb links from the root down to packageTreeNode.

This method actually handles the recursion.

  writePreformatted 
writePreformatted (
        self,
        output,
        text,
        )

Write text as a preformatted section.

  writeSectionTitle 
writeSectionTitle (
        self,
        output,
        title,
        subtitle,
        anchor=None,
        )

Generate the text and styles to begin a new section.

  writeImport 
writeImport (
        self,
        output,
        packageTreeNode,
        moduleReference,
        )

Write an import statement: import X

  writeTOCFile 
writeTOCFile ( self,  packageTreeNode )

Write the table of contents for a directory.

The packageTreeNode is a directory, and the table of contents for that directory should be written as appropriate.

  writeTOCReferencesSection 
writeTOCReferencesSection (
        self,
        output,
        packageTreeNode,
        title,
        moduleList,
        )

Write a list of references in the table of contents.

Arguments
output
Open output stream on which to write.
packageTreeNode
The node for which the section is being written.
title
Title of the reference section.
moduleList
A list of nodes to be included in the reference section.
  writeList 
writeList (
        self,
        output,
        listElements,
        )

Write a formatted list of values to the output.

  writeImportForKnownModule 
writeImportForKnownModule (
        self,
        output,
        packageTreeNode,
        name,
        referencedModule,
        symbols,
        )

Write an import statement for a module known to HappyDoc.

Handles either from X import Y or import X. The module name is a link to the documentation for that module within the HappyDoc-generated output.

  writeImportForPythonSystemModule 
writeImportForPythonSystemModule (
        self,
        output,
        packageTreeNode,
        name,
        symbols,
        url,
        )

Write an import statement for a Python system module.

Handles either from X import Y or import X. The module name is a link to the Python documentation on http://www.python.org.

  writeBaseClassNames 
writeBaseClassNames (
        self,
        output,
        packageTreeNode,
        classInfo,
        )
  popSectionLevel 
popSectionLevel ( self,  output )

Decrease the section level.

Generate the text and styles to close the current section and change the section level to the next higher level.


This document was automatically generated Tue Dec 5 08:30:59 2006 by HappyDoc version 3.1