eric3.DocumentationTools.IndexGenerator
Module implementing the index generator for the builtin documentation generator.
Classes
IndexGenerator |
Class implementing the index generator for the builtin documentation generator. |
Functions
IndexGenerator
Class implementing the index generator for the builtin documentation generator.
Derived from
Methods
IndexGenerator (Constructor)
IndexGenerator(outputDir, prefix = "eric3doc")
Constructor
- outputDir
-
The output directory for the files. (string)
- prefix
-
The filename prefix of the generated documentation
files. (string)
IndexGenerator.remember
remember(file, moduleDocument, basename="")
Method to remember a documentation file.
- basename
-
The basename of the file hierarchy to be documented.
The basename is stripped off the filename if it starts with
the basename.
- file
-
The filename to be remembered. (string)
- moduleDocument
-
The ModuleDocument object containing the
information for the file.
IndexGenerator.writeIndex
writeIndex(packagename, package)
Method to generate an index file for a package.
- package
-
A dictionary with information about the package.
- packagename
-
The name of the package. (string)
- Returns:
-
The name of the generated index file.
IndexGenerator.writeIndices
writeIndices(basename = "")
Method to generate all index files.
- basename
-
The basename of the file hierarchy to be documented.
The basename is stripped off the filename if it starts with
the basename.