/ HappyDoc3-r3_1 / happydoclib / docset / base.py / DocSetBase
Base class for documentation sets.
This is the base class for all documentation set classes. The
methods defined here are required of all docset classes. Only the
write method is actually used by the main application.
Methods
|
|
|
write
|
write ( self )
Called by the application to cause the docset to be written.
Exceptions
|
|
NotImplementedError( '%s.write' % self.__class__.__name__ )
|
|
|
statusMessage
|
statusMessage (
self,
message='',
verboseLevel=1,
)
Print a status message for the user.
|
|
__init__
|
__init__ (
self,
scanner,
title,
outputDirectory,
statusMessageFunc=None,
extraParameters={},
)
Basic Documentation Set
Parameters
- scanner
- A directory tree scanner.
- title
- the title of the documentation set
- outputDirectory
- The base directory for writing the
output files.
- statusMessageFunc
- function which will print a status
message for the user
- extraParameters
- Dictionary containing parameters
specified on the command line by
the user.
|
|
warningMessage
|
warningMessage ( self, message='' )
|
|
|