Table of Contents

Class: DocSet HappyDoc-r0_7_1/docset/docset_multiplefile.py

DocSet where documentation is written to multiple files.

Do not use multiple lines in the class docstring, since it shows up as part of the generated help message for the app and multiple lines throws off the formatting.

Base Classes   
UserList.UserList
Methods   
__init__
_writeBaseclassNames
_writeClass
_writeFunction
_writeIndex
_writeModule
_writeModules
_writeTOC
append
close
closeOutput
getBaseDirectory
getClassInfo
openOutput
statusMessage
write
  __init__ 
__init__ (
        self,
        formatterFactory,
        list=None,
        title='HappyDoc Generated Documentation',
        baseDirectory=None,
        statusMessageFunc=None,
        description='',
        appName='HappyDoc',
        appVersion='',
        appHome='',
        author='',
        formatterParameters={},
        **extraNamedParameters,
        )

Initialize the documentation set.

Parameters:

formatterFactory

a callable object which creates the type of formatter class to be used for formatting the documentation set. The object will be called and passed the DocSet along with other configuration values for the formatter.

list

an initial list of info objects from parseinfo.py

title

the title of the documentation set

baseDirectory

the name of the root directory where output file(s) should be written

statusMessageFunc

function which will print a status message for the user

description

text describing the docset as a whole

formatterParameters

other named configuration values to be passed to the formatter when it is created through the factory. Any unrecognized values will be quietly ignored.

  _writeBaseclassNames 
_writeBaseclassNames (
        self,
        parent,
        classInfo,
        output,
        indent=0,
        )

Output the base class hierarchy for the given class.

  _writeClass 
_writeClass (
        self,
        parent,
        class_name,
        output,
        )

Output the documentation for the class in the parent object.

Base class hierarchy

Start the indented section

Write the info for the methods of this class

TOC list

Finish that indented level.

  _writeFunction 
_writeFunction (
        self,
        function_name,
        getInfo,
        output,
        )

Output the documentation for the function in the parent object.

Header

Function signature

Docstring

Exceptions

  _writeIndex 
_writeIndex ( self )

Output the index.

  _writeModule 
_writeModule ( self,  module_name )

Output the documentation for the module named.

Write the doc string

Start the indented section

List the dependant modules

Process the list of imported names and generate references to the ones which are recognized by our parser.

do not have this name?

  _writeModules 
_writeModules ( self )

Output documentation for all modules.

  _writeTOC 
_writeTOC ( self )

Output the TOC.

Open a new section and list

Write module references to the list

module_names = self._all_modules.keys() module_names.sort()

  append 
append ( self,  infoObject )

  close 
close ( self )

Close the open documentation set.

  closeOutput 
closeOutput ( self,  output )

Close the output handle.

  getBaseDirectory 
getBaseDirectory ( self )

Returns the base directory for this documentation set.

  getClassInfo 
getClassInfo ( self,  className )

Returns class info if have it, None otherwise.

  openOutput 
openOutput (
        self,
        name,
        title,
        subtitle,
        )

Using this method to open output destinations means they will automatically be closed.

  statusMessage 
statusMessage ( self,  message='' )

Print a status message for the user.

  write 
write ( self )

Write the documentation set to the output.

Create the formatter

Get the name of and open the docset root file

Write the output

Close things up


Table of Contents

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