Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.DocumentationTools.IndexGenerator.html

Documentation/Source/eric5.DocumentationTools.IndexGenerator.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 253
3ccdf551bde7
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.DocumentationTools.IndexGenerator</h1> 23 <h1>eric5.DocumentationTools.IndexGenerator</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#100;&#101;x &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;. 25 Module implementing the index generator for the builtin documentation generator.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#IndexGenerator">IndexGenerator</a></td> 34 <td><a href="#IndexGenerator">IndexGenerator</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#100;&#101;x &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.</td> 35 <td>Class implementing the index generator for the builtin documentation generator.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="IndexGenerator" ID="IndexGenerator"></a> 43 <a NAME="IndexGenerator" ID="IndexGenerator"></a>
44 <h2>IndexGenerator</h2> 44 <h2>IndexGenerator</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#100;&#101;x &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;. 46 Class implementing the index generator for the builtin documentation generator.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 object 49 object
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> 57 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> 60 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td>
61 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#110; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101; &#102;&#111;&#114; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.</td> 61 <td>Private method to generate an index file for a package.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#IndexGenerator.remember">remember</a></td> 63 <td><a href="#IndexGenerator.remember">remember</a></td>
64 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.</td> 64 <td>Public method to remember a documentation file.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> 66 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td>
67 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.</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 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 74 Constructor
75 </p><dl> 75 </p><dl>
76 <dt><i>outputDir</i></dt> 76 <dt><i>outputDir</i></dt>
77 <dd> 77 <dd>
78 &#84;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#115;. (&#115;&#116;&#114;&#105;&#110;&#103;) 78 The output directory for the files. (string)
79 </dd><dt><i>colors</i></dt> 79 </dd><dt><i>colors</i></dt>
80 <dd> 80 <dd>
81 &#68;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#115;&#112;&#101;&#99;&#105;&#102;y&#105;&#110;&#103; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#99;&#111;&#108;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116;. 81 Dictionary specifying the various colors for the output.
82 (&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 82 (dictionary of strings)
83 </dd><dt><i>stylesheet</i></dt> 83 </dd><dt><i>stylesheet</i></dt>
84 <dd> 84 <dd>
85 &#116;&#104;&#101; &#115;&#116;y&#108;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#112;&#97;&#103;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;) 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</i>) 89 <b>__writeIndex</b>(<i>packagename, package</i>)
90 <p> 90 <p>
91 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#110; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101; &#102;&#111;&#114; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;. 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>
95 &#84;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;. (&#115;&#116;&#114;&#105;&#110;&#103;) 95 The name of the package. (string)
96 </dd><dt><i>package</i></dt> 96 </dd><dt><i>package</i></dt>
97 <dd> 97 <dd>
98 &#65; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y w&#105;&#116;&#104; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#97;&#98;&#111;&#117;&#116; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;. 98 A dictionary with information about the package.
99 </dd> 99 </dd>
100 </dl><dl> 100 </dl><dl>
101 <dt>Returns:</dt> 101 <dt>Returns:</dt>
102 <dd> 102 <dd>
103 &#84;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;. 103 The name of the generated index file.
104 </dd> 104 </dd>
105 </dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> 105 </dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a>
106 <h4>IndexGenerator.remember</h4> 106 <h4>IndexGenerator.remember</h4>
107 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) 107 <b>remember</b>(<i>file, moduleDocument, basename=""</i>)
108 <p> 108 <p>
109 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;. 109 Public method to remember a documentation file.
110 </p><dl> 110 </p><dl>
111 <dt><i>file</i></dt> 111 <dt><i>file</i></dt>
112 <dd> 112 <dd>
113 &#84;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114;&#101;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;) 113 The filename to be remembered. (string)
114 </dd><dt><i>moduleDocument</i></dt> 114 </dd><dt><i>moduleDocument</i></dt>
115 <dd> 115 <dd>
116 &#84;&#104;&#101; &#77;&#111;&#100;&#117;&#108;&#101;&#68;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; 116 The ModuleDocument object containing the
117 &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. 117 information for the file.
118 </dd><dt><i>basename</i></dt> 118 </dd><dt><i>basename</i></dt>
119 <dd> 119 <dd>
120 &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;. 120 The basename of the file hierarchy to be documented.
121 &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104; 121 The basename is stripped off the filename if it starts with
122 &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;. 122 the basename.
123 </dd> 123 </dd>
124 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> 124 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a>
125 <h4>IndexGenerator.writeIndices</h4> 125 <h4>IndexGenerator.writeIndices</h4>
126 <b>writeIndices</b>(<i>basename = ""</i>) 126 <b>writeIndices</b>(<i>basename = ""</i>)
127 <p> 127 <p>
128 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;. 128 Public method to generate all index files.
129 </p><dl> 129 </p><dl>
130 <dt><i>basename</i></dt> 130 <dt><i>basename</i></dt>
131 <dd> 131 <dd>
132 &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;. 132 The basename of the file hierarchy to be documented.
133 &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104; 133 The basename is stripped off the filename if it starts with
134 &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;. 134 the basename.
135 </dd> 135 </dd>
136 </dl> 136 </dl>
137 <div align="right"><a href="#top">Up</a></div> 137 <div align="right"><a href="#top">Up</a></div>
138 <hr /> 138 <hr />
139 </body></html> 139 </body></html>

Mercurial Repository: eric

eric ide

mercurial