_writeBaseClassNames (
        self,
        parent,
        cinfo,
        output,
        indent=0,
        )

Output the base class hierarchy for the given class.

Arguments

parent

info about class parent (module, class)

cinfo

class info

output

current output file object

_writeClass (
        self,
        parent,
        class_name,
        output,
        )

Output the documentation for the class in the parent object.

Arguments

parent

info about class parent (module, class)

class_name

name of the class

output

current output file object

_writeFunction (
        self,
        function_name,
        getInfo,
        output,
        )

Output the documentation for the function in the parent object.

Arguments

function_name

the function name

getInfo

reference to method, which will return function info

output

current output file object

_writeModule ( self,  module_name )

Output the documentation for the named module.

Arguments

module_name

name of the module

_writeModules ( self )

Output documentation for all modules.

_writePackages ( self )

Output documentation for all packages.

closeOutput (
        self,
        output,
        rtype=INDEX_FILE,
        )

Closes output, where documentation has been written.

Arguments

output

file object of opened documentation file

rtype

gives info whether index, module or class file will be closed

openOutput (
        self,
        name,
        title,
        subtitle,
        rtype=INDEX_FILE,
        )

Opens output, where documentation will be written.

Arguments

name

output file name

title

title of documentation file

subtitle

subtitle of documentation file

rtype

gives info whether index, module or class file will be opened

Returns file object of opened documentation file.

write ( self )

Write the documentation set to the output.