Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html
src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10423
- 299802979277
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DocumentationTools.IndexGenerator</h1> | 9 <h1>eric7.DocumentationTools.IndexGenerator</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the index generator for the builtin documentation | 11 Module implementing the index generator for the builtin documentation |
| 13 generator. | 12 generator. |
| 14 </p> | 13 </p> |
| 14 | |
| 15 <h3>Global Attributes</h3> | 15 <h3>Global Attributes</h3> |
| 16 | |
| 17 <table> | 16 <table> |
| 18 <tr><td>None</td></tr> | 17 <tr><td>None</td></tr> |
| 19 </table> | 18 </table> |
| 19 | |
| 20 <h3>Classes</h3> | 20 <h3>Classes</h3> |
| 21 | |
| 22 <table> | 21 <table> |
| 23 | |
| 24 <tr> | 22 <tr> |
| 25 <td><a href="#IndexGenerator">IndexGenerator</a></td> | 23 <td><a href="#IndexGenerator">IndexGenerator</a></td> |
| 26 <td>Class implementing the index generator for the builtin documentation generator.</td> | 24 <td>Class implementing the index generator for the builtin documentation generator.</td> |
| 27 </tr> | 25 </tr> |
| 28 </table> | 26 </table> |
| 27 | |
| 29 <h3>Functions</h3> | 28 <h3>Functions</h3> |
| 30 | |
| 31 <table> | 29 <table> |
| 32 <tr><td>None</td></tr> | 30 <tr><td>None</td></tr> |
| 33 </table> | 31 </table> |
| 32 | |
| 34 <hr /> | 33 <hr /> |
| 35 <hr /> | 34 <hr /> |
| 36 <a NAME="IndexGenerator" ID="IndexGenerator"></a> | 35 <a NAME="IndexGenerator" ID="IndexGenerator"></a> |
| 37 <h2>IndexGenerator</h2> | 36 <h2>IndexGenerator</h2> |
| 38 | |
| 39 <p> | 37 <p> |
| 40 Class implementing the index generator for the builtin documentation | 38 Class implementing the index generator for the builtin documentation |
| 41 generator. | 39 generator. |
| 42 </p> | 40 </p> |
| 41 | |
| 43 <h3>Derived from</h3> | 42 <h3>Derived from</h3> |
| 44 None | 43 None |
| 45 <h3>Class Attributes</h3> | 44 <h3>Class Attributes</h3> |
| 46 | |
| 47 <table> | 45 <table> |
| 48 <tr><td>None</td></tr> | 46 <tr><td>None</td></tr> |
| 49 </table> | 47 </table> |
| 48 | |
| 50 <h3>Class Methods</h3> | 49 <h3>Class Methods</h3> |
| 51 | |
| 52 <table> | 50 <table> |
| 53 <tr><td>None</td></tr> | 51 <tr><td>None</td></tr> |
| 54 </table> | 52 </table> |
| 53 | |
| 55 <h3>Methods</h3> | 54 <h3>Methods</h3> |
| 56 | |
| 57 <table> | 55 <table> |
| 58 | |
| 59 <tr> | 56 <tr> |
| 60 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> | 57 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> |
| 61 <td>Constructor</td> | 58 <td>Constructor</td> |
| 62 </tr> | 59 </tr> |
| 63 <tr> | 60 <tr> |
| 71 <tr> | 68 <tr> |
| 72 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> | 69 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> |
| 73 <td>Public method to generate all index files.</td> | 70 <td>Public method to generate all index files.</td> |
| 74 </tr> | 71 </tr> |
| 75 </table> | 72 </table> |
| 73 | |
| 76 <h3>Static Methods</h3> | 74 <h3>Static Methods</h3> |
| 77 | |
| 78 <table> | 75 <table> |
| 79 <tr><td>None</td></tr> | 76 <tr><td>None</td></tr> |
| 80 </table> | 77 </table> |
| 81 | 78 |
| 79 | |
| 82 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> | 80 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> |
| 83 <h4>IndexGenerator (Constructor)</h4> | 81 <h4>IndexGenerator (Constructor)</h4> |
| 84 <b>IndexGenerator</b>(<i>outputDir</i>) | 82 <b>IndexGenerator</b>(<i>outputDir</i>) |
| 85 | |
| 86 <p> | 83 <p> |
| 87 Constructor | 84 Constructor |
| 88 </p> | 85 </p> |
| 86 | |
| 89 <dl> | 87 <dl> |
| 90 | 88 |
| 91 <dt><i>outputDir</i> (str)</dt> | 89 <dt><i>outputDir</i> (str)</dt> |
| 92 <dd> | 90 <dd> |
| 93 The output directory for the files | 91 The output directory for the files |
| 94 </dd> | 92 </dd> |
| 95 </dl> | 93 </dl> |
| 96 <a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | 94 <a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> |
| 97 <h4>IndexGenerator.__writeIndex</h4> | 95 <h4>IndexGenerator.__writeIndex</h4> |
| 98 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) | 96 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) |
| 99 | |
| 100 <p> | 97 <p> |
| 101 Private method to generate an index file for a package. | 98 Private method to generate an index file for a package. |
| 102 </p> | 99 </p> |
| 100 | |
| 103 <dl> | 101 <dl> |
| 104 | 102 |
| 105 <dt><i>packagename</i> (str)</dt> | 103 <dt><i>packagename</i> (str)</dt> |
| 106 <dd> | 104 <dd> |
| 107 The name of the package. | 105 The name of the package. |
| 128 </dd> | 126 </dd> |
| 129 </dl> | 127 </dl> |
| 130 <a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | 128 <a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> |
| 131 <h4>IndexGenerator.remember</h4> | 129 <h4>IndexGenerator.remember</h4> |
| 132 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | 130 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) |
| 133 | |
| 134 <p> | 131 <p> |
| 135 Public method to remember a documentation file. | 132 Public method to remember a documentation file. |
| 136 </p> | 133 </p> |
| 134 | |
| 137 <dl> | 135 <dl> |
| 138 | 136 |
| 139 <dt><i>file</i> (str)</dt> | 137 <dt><i>file</i> (str)</dt> |
| 140 <dd> | 138 <dd> |
| 141 The filename to be remembered. | 139 The filename to be remembered. |
| 153 </dd> | 151 </dd> |
| 154 </dl> | 152 </dl> |
| 155 <a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | 153 <a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> |
| 156 <h4>IndexGenerator.writeIndices</h4> | 154 <h4>IndexGenerator.writeIndices</h4> |
| 157 <b>writeIndices</b>(<i>basename="", newline=None</i>) | 155 <b>writeIndices</b>(<i>basename="", newline=None</i>) |
| 158 | |
| 159 <p> | 156 <p> |
| 160 Public method to generate all index files. | 157 Public method to generate all index files. |
| 161 </p> | 158 </p> |
| 159 | |
| 162 <dl> | 160 <dl> |
| 163 | 161 |
| 164 <dt><i>basename</i> (str)</dt> | 162 <dt><i>basename</i> (str)</dt> |
| 165 <dd> | 163 <dd> |
| 166 base name of the file hierarchy to be documented. | 164 base name of the file hierarchy to be documented. |
