--- a/eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,30 +18,38 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<hr /> +<hr /> <a NAME="IndexGenerator" ID="IndexGenerator"></a> <h2>IndexGenerator</h2> + <p> Class implementing the index generator for the builtin documentation generator. @@ -49,102 +57,134 @@ <h3>Derived from</h3> object <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> +</tr> +<tr> <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> <td>Private method to generate an index file for a package.</td> -</tr><tr> +</tr> +<tr> <td><a href="#IndexGenerator.remember">remember</a></td> <td>Public method to remember a documentation file.</td> -</tr><tr> +</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, colors, stylesheet=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>outputDir</i></dt> <dd> The output directory for the files. (string) -</dd><dt><i>colors</i></dt> +</dd> +<dt><i>colors</i></dt> <dd> Dictionary specifying the various colors for the output. (dictionary of strings) -</dd><dt><i>stylesheet</i></dt> +</dd> +<dt><i>stylesheet</i></dt> <dd> the style to be used for the generated pages (string) </dd> -</dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> +</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> +</p> +<dl> + <dt><i>packagename</i></dt> <dd> The name of the package. (string) -</dd><dt><i>package</i></dt> +</dd> +<dt><i>package</i></dt> <dd> A dictionary with information about the package. -</dd><dt><i>newline</i></dt> +</dd> +<dt><i>newline</i></dt> <dd> newline character to be used (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> The name of the generated index file. </dd> -</dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> +</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> +</p> +<dl> + <dt><i>file</i></dt> <dd> The filename to be remembered. (string) -</dd><dt><i>moduleDocument</i></dt> +</dd> +<dt><i>moduleDocument</i></dt> <dd> The ModuleDocument object containing the information for the file. -</dd><dt><i>basename</i></dt> +</dd> +<dt><i>basename</i></dt> <dd> The basename of the file hierarchy to be documented. The basename is stripped off the filename if it starts with the basename. </dd> -</dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> +</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> +</p> +<dl> + <dt><i>basename</i></dt> <dd> The basename of the file hierarchy to be documented. The basename is stripped off the filename if it starts with the basename. -</dd><dt><i>newline</i></dt> +</dd> +<dt><i>newline</i></dt> <dd> newline character to be used (string) </dd>