Documentation set written to multiple files.
Parameters
Adds no additional parameters not understood by DocSet.
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.
|
Methods
|
|
|
|
|
|
_describeClassInModuleNode
|
_describeClassInModuleNode (
self,
output,
class_output_file_name,
class_info,
)
|
|
|
_organizeSubNodesByDir
|
_organizeSubNodesByDir (
self,
outputDict,
inputDict,
removePrefix=0,
)
|
|
|
_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.
|
|
|
_writeDescription
|
_writeDescription ( self, output )
Write the contents of the description file in directoryName to output.
|
|
|
_writeExceptionListForFunction
|
_writeExceptionListForFunction (
self,
output,
function,
listHeader,
)
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.
|
|
|
_writeFunction
|
_writeFunction (
self,
function_name,
getInfo,
output,
)
Output the documentation for the function in the parent object.
|
|
|
_writeFunctionParameter
|
_writeFunctionParameter (
self,
name,
info,
output,
)
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
|
|
|
_writeFunctionSignature
|
_writeFunctionSignature (
self,
function,
output,
)
Write the function signature for function to output.
Parameters
- function
- Instance of FunctionInfo from parseinfo module.
- output
- Where to write.
|
|
|
_writeIndex
|
_writeIndex ( self )
Output the index.
|
|
|
_writeModule
|
_writeModule ( self, module_name )
Output the documentation for the module named.
|
|
|
_writeModuleImportList
|
_writeModuleImportList (
self,
module_name,
module,
output_name,
output,
)
|
|
|
_writeModules
|
_writeModules ( self )
Output documentation for all modules.
|
|
|
_writePackages
|
_writePackages ( self )
Output documentation for all packages.
|
|
|
_writePrewrittenFiles
|
_writePrewrittenFiles ( self )
Convert the format of the discovered pre-written files.
Convert the format of the discovered pre-written files.
and write out new files as part of the docset.
|
|
|
_writeTOC
|
_writeTOC ( self )
Output the TOC.
|
|
|
write
|
write ( self )
Write the documentation set to the output.
|
|