|
writeFileHeader
|
writeFileHeader (
self,
output,
packageTreeNode,
title='',
subtitle='',
)
Does nothing.
|
|
processPythonClass
|
processPythonClass ( self, packageTreeNode )
Writes information about classes in this module to the output stream.
|
|
getPythonSubNodes
|
getPythonSubNodes ( self, node )
Return a list of subnodes with mimetype text/x-python,
filtering out __init__.py if it is present.
|
|
writeTOCFile
|
writeTOCFile ( self, packageTreeNode )
Write the table of contents for a directory.
Subclasses must implement this method.
The packageTreeNode is a directory, and the table of contents
for that directory should be written as appropriate.
|
|
_initializeWriters
|
_initializeWriters ( self )
Hook to allow subclasses to register writers without having to
override __init__ with all of its arguments.
|
|
writeFileFooter
|
writeFileFooter ( self, output )
Does nothing.
|
|
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
|
|
processPlainTextFile
|
processPlainTextFile ( self, packageTreeNode )
Handler for text/x-structured and text/plain nodes.
Converts the input file to the output file format and
generates the output. The output directory is assumed to
already exist.
|
|
getImportData
|
getImportData ( self, packageTreeNode )
Retrieves the import data for the node, and converts
the data structure to something that is easier to work
with in the template.
|
|
getHREFToNode
|
getHREFToNode (
self,
source,
destination,
)
Returns the HREF pointing to destination from the current node.
|
|
processPythonFile
|
processPythonFile ( self, packageTreeNode )
Handler for text/x-python nodes.
|
|
__init__
|
__init__ (
self,
scanner,
title,
outputDirectory,
includeComments=1,
includePrivateNames=1,
sortNames=0,
statusMessageFunc=None,
extraParameters={},
)
|
|
renderTemplateToFile
|
renderTemplateToFile (
self,
template,
outputFilename,
packageTreeNode,
**extraContext,
)
|
|