1 <!DOCTYPE html> |
1 <!DOCTYPE html> |
2 <html><head> |
2 <html><head> |
3 <title>eric7.DocumentationTools.IndexGenerator</title> |
3 <title>eric7.DocumentationTools.IndexGenerator</title> |
4 <meta charset="UTF-8"> |
4 <meta charset="UTF-8"> |
5 <style> |
5 <link rel="stylesheet" href="styles.css"> |
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
6 </head> |
21 <body> |
7 <body> |
22 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
23 <h1>eric7.DocumentationTools.IndexGenerator</h1> |
9 <h1>eric7.DocumentationTools.IndexGenerator</h1> |
24 |
10 |
93 <tr><td>None</td></tr> |
79 <tr><td>None</td></tr> |
94 </table> |
80 </table> |
95 |
81 |
96 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> |
82 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> |
97 <h4>IndexGenerator (Constructor)</h4> |
83 <h4>IndexGenerator (Constructor)</h4> |
98 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet=None</i>) |
84 <b>IndexGenerator</b>(<i>outputDir</i>) |
99 |
85 |
100 <p> |
86 <p> |
101 Constructor |
87 Constructor |
102 </p> |
88 </p> |
103 <dl> |
89 <dl> |
104 |
90 |
105 <dt><i>outputDir</i></dt> |
91 <dt><i>outputDir</i> (str)</dt> |
106 <dd> |
92 <dd> |
107 The output directory for the files. (string) |
93 The output directory for the files |
108 </dd> |
|
109 <dt><i>colors</i></dt> |
|
110 <dd> |
|
111 Dictionary specifying the various colors for the output. |
|
112 (dictionary of strings) |
|
113 </dd> |
|
114 <dt><i>stylesheet</i></dt> |
|
115 <dd> |
|
116 the style to be used for the generated pages (string) |
|
117 </dd> |
94 </dd> |
118 </dl> |
95 </dl> |
119 <a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> |
96 <a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> |
120 <h4>IndexGenerator.__writeIndex</h4> |
97 <h4>IndexGenerator.__writeIndex</h4> |
121 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) |
98 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) |