eric4.DocumentationTools.QtHelpGenerator
Module implementing the QtHelp generator for the builtin documentation generator.
Global Attributes
| HelpCollection |
| HelpCollectionFile |
| HelpCollectionProjectFile |
| HelpHelpFile |
| HelpProject |
| HelpProjectFile |
Classes
| QtHelpGenerator |
Class implementing the QtHelp generator for the builtin documentation generator. |
Functions
QtHelpGenerator
Class implementing the QtHelp generator for the builtin documentation generator.
Derived from
object
Class Attributes
Class Methods
Methods
Static Methods
QtHelpGenerator (Constructor)
QtHelpGenerator(htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection)
Constructor
- htmlDir
-
directory containing the HTML files (string)
- outputDir
-
output directory for the files (string)
- namespace
-
namespace to be used (string)
- virtualFolder
-
virtual folder to be used (string)
- filterName
-
name of the custom filter (string)
- filterAttributes
-
':' separated list of filter attributes (string)
- title
-
title to be used for the generated help (string)
- createCollection
-
flag indicating the generation of the collection
files (boolean)
QtHelpGenerator.__generateKeywords
__generateKeywords()
Private method to generate the keywords section.
- Returns:
-
keywords section (string)
QtHelpGenerator.__generateSections
__generateSections(package, level)
Private method to generate the sections part.
- package
-
name of the package to process (string)
- level
-
indentation level (integer)
- Returns:
-
sections part (string)
QtHelpGenerator.generateFiles
generateFiles(basename = "")
Public 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.
QtHelpGenerator.remember
remember(file, moduleDocument, basename="")
Public method to remember a documentation file.
- file
-
The filename to be remembered. (string)
- moduleDocument
-
The ModuleDocument object containing the
information for the file.
- basename
-
The basename of the file hierarchy to be documented.
The basename is stripped off the filename if it starts with
the basename.