Documentation/Source/eric5.DocumentationTools.IndexGenerator.html

changeset 945
8cd4d08fa9f6
parent 440
69ace3e2dcf6
child 1228
7afaf2fca55b
equal deleted inserted replaced
944:1b59c4ba121e 945:8cd4d08fa9f6
67 <td>Public method to generate all index files.</td> 67 <td>Public method to generate all index files.</td>
68 </tr> 68 </tr>
69 </table> 69 </table>
70 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> 70 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a>
71 <h4>IndexGenerator (Constructor)</h4> 71 <h4>IndexGenerator (Constructor)</h4>
72 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet = None</i>) 72 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet=None</i>)
73 <p> 73 <p>
74 Constructor 74 Constructor
75 </p><dl> 75 </p><dl>
76 <dt><i>outputDir</i></dt> 76 <dt><i>outputDir</i></dt>
77 <dd> 77 <dd>
84 <dd> 84 <dd>
85 the style to be used for the generated pages (string) 85 the style to be used for the generated pages (string)
86 </dd> 86 </dd>
87 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> 87 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a>
88 <h4>IndexGenerator.__writeIndex</h4> 88 <h4>IndexGenerator.__writeIndex</h4>
89 <b>__writeIndex</b>(<i>packagename, package, newline = None</i>) 89 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>)
90 <p> 90 <p>
91 Private method to generate an index file for a package. 91 Private method to generate an index file for a package.
92 </p><dl> 92 </p><dl>
93 <dt><i>packagename</i></dt> 93 <dt><i>packagename</i></dt>
94 <dd> 94 <dd>
124 The basename is stripped off the filename if it starts with 124 The basename is stripped off the filename if it starts with
125 the basename. 125 the basename.
126 </dd> 126 </dd>
127 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> 127 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a>
128 <h4>IndexGenerator.writeIndices</h4> 128 <h4>IndexGenerator.writeIndices</h4>
129 <b>writeIndices</b>(<i>basename = "", newline = None</i>) 129 <b>writeIndices</b>(<i>basename="", newline=None</i>)
130 <p> 130 <p>
131 Public method to generate all index files. 131 Public method to generate all index files.
132 </p><dl> 132 </p><dl>
133 <dt><i>basename</i></dt> 133 <dt><i>basename</i></dt>
134 <dd> 134 <dd>

eric ide

mercurial