src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html

<!DOCTYPE html>
<html><head>
<title>eric7.DocumentationTools.IndexGenerator</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DocumentationTools.IndexGenerator</h1>
<p>
Module implementing the index generator for the builtin documentation
generator.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#IndexGenerator">IndexGenerator</a></td>
<td>Class implementing the index generator for the builtin documentation generator.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="IndexGenerator" ID="IndexGenerator"></a>
<h2>IndexGenerator</h2>
<p>
    Class implementing the index generator for the builtin documentation
    generator.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#IndexGenerator.__init__">IndexGenerator</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td>
<td>Private method to generate an index file for a package.</td>
</tr>
<tr>
<td><a href="#IndexGenerator.remember">remember</a></td>
<td>Public method to remember a documentation file.</td>
</tr>
<tr>
<td><a href="#IndexGenerator.writeIndices">writeIndices</a></td>
<td>Public method to generate all index files.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a>
<h4>IndexGenerator (Constructor)</h4>
<b>IndexGenerator</b>(<i>outputDir</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>outputDir</i> (str)</dt>
<dd>
The output directory for the files
</dd>
</dl>
<a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a>
<h4>IndexGenerator.__writeIndex</h4>
<b>__writeIndex</b>(<i>packagename, package, newline=None</i>)
<p>
        Private method to generate an index file for a package.
</p>

<dl>

<dt><i>packagename</i> (str)</dt>
<dd>
The name of the package.
</dd>
<dt><i>package</i> (dict)</dt>
<dd>
dictionary with information about the package
</dd>
<dt><i>newline</i> (str)</dt>
<dd>
newline character to be used
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
name of the generated index file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a>
<h4>IndexGenerator.remember</h4>
<b>remember</b>(<i>file, moduleDocument, basename=""</i>)
<p>
        Public method to remember a documentation file.
</p>

<dl>

<dt><i>file</i> (str)</dt>
<dd>
The filename to be remembered.
</dd>
<dt><i>moduleDocument</i> (ModuleDocument)</dt>
<dd>
module documentation object containing the
            information for the file
</dd>
<dt><i>basename</i> (str)</dt>
<dd>
base name of the file hierarchy to be documented.
            The base name is stripped off the filename if it starts with
            the base name.
</dd>
</dl>
<a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a>
<h4>IndexGenerator.writeIndices</h4>
<b>writeIndices</b>(<i>basename="", newline=None</i>)
<p>
        Public method to generate all index files.
</p>

<dl>

<dt><i>basename</i> (str)</dt>
<dd>
base name of the file hierarchy to be documented.
            The base name is stripped off the filename if it starts with
            the base name.
</dd>
<dt><i>newline</i> (str)</dt>
<dd>
newline character to be used
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>