eric7.DocumentationTools.IndexGenerator

Module implementing the index generator for the builtin documentation generator.

Global Attributes

None

Classes

IndexGenerator Class implementing the index generator for the builtin documentation generator.

Functions

None


IndexGenerator

Class implementing the index generator for the builtin documentation generator.

Derived from

None

Class Attributes

None

Class Methods

None

Methods

IndexGenerator Constructor
__writeIndex Private method to generate an index file for a package.
remember Public method to remember a documentation file.
writeIndices Public method to generate all index files.

Static Methods

None

IndexGenerator (Constructor)

IndexGenerator(outputDir)

Constructor

outputDir (str)
The output directory for the files

IndexGenerator.__writeIndex

__writeIndex(packagename, package, newline=None)

Private method to generate an index file for a package.

packagename (str)
The name of the package.
package (dict)
dictionary with information about the package
newline (str)
newline character to be used
Return:
name of the generated index file
Return Type:
str

IndexGenerator.remember

remember(file, moduleDocument, basename="")

Public method to remember a documentation file.

file (str)
The filename to be remembered.
moduleDocument (ModuleDocument)
module documentation object containing the information for the file
basename (str)
base name of the file hierarchy to be documented. The base name is stripped off the filename if it starts with the base name.

IndexGenerator.writeIndices

writeIndices(basename="", newline=None)

Public method to generate all index files.

basename (str)
base name of the file hierarchy to be documented. The base name is stripped off the filename if it starts with the base name.
newline (str)
newline character to be used
Up