Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html
eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.DocumentationTools.IndexGenerator</h1> | 23 <h1>eric6.DocumentationTools.IndexGenerator</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the index generator for the builtin documentation | 26 Module implementing the index generator for the builtin documentation |
| 25 generator. | 27 generator. |
| 26 </p> | 28 </p> |
| 27 <h3>Global Attributes</h3> | 29 <h3>Global Attributes</h3> |
| 30 | |
| 28 <table> | 31 <table> |
| 29 <tr><td>None</td></tr> | 32 <tr><td>None</td></tr> |
| 30 </table> | 33 </table> |
| 31 <h3>Classes</h3> | 34 <h3>Classes</h3> |
| 35 | |
| 32 <table> | 36 <table> |
| 37 | |
| 33 <tr> | 38 <tr> |
| 34 <td><a href="#IndexGenerator">IndexGenerator</a></td> | 39 <td><a href="#IndexGenerator">IndexGenerator</a></td> |
| 35 <td>Class implementing the index generator for the builtin documentation generator.</td> | 40 <td>Class implementing the index generator for the builtin documentation generator.</td> |
| 36 </tr> | 41 </tr> |
| 37 </table> | 42 </table> |
| 38 <h3>Functions</h3> | 43 <h3>Functions</h3> |
| 44 | |
| 39 <table> | 45 <table> |
| 40 <tr><td>None</td></tr> | 46 <tr><td>None</td></tr> |
| 41 </table> | 47 </table> |
| 42 <hr /><hr /> | 48 <hr /> |
| 49 <hr /> | |
| 43 <a NAME="IndexGenerator" ID="IndexGenerator"></a> | 50 <a NAME="IndexGenerator" ID="IndexGenerator"></a> |
| 44 <h2>IndexGenerator</h2> | 51 <h2>IndexGenerator</h2> |
| 52 | |
| 45 <p> | 53 <p> |
| 46 Class implementing the index generator for the builtin documentation | 54 Class implementing the index generator for the builtin documentation |
| 47 generator. | 55 generator. |
| 48 </p> | 56 </p> |
| 49 <h3>Derived from</h3> | 57 <h3>Derived from</h3> |
| 50 object | 58 object |
| 51 <h3>Class Attributes</h3> | 59 <h3>Class Attributes</h3> |
| 60 | |
| 52 <table> | 61 <table> |
| 53 <tr><td>None</td></tr> | 62 <tr><td>None</td></tr> |
| 54 </table> | 63 </table> |
| 55 <h3>Class Methods</h3> | 64 <h3>Class Methods</h3> |
| 65 | |
| 56 <table> | 66 <table> |
| 57 <tr><td>None</td></tr> | 67 <tr><td>None</td></tr> |
| 58 </table> | 68 </table> |
| 59 <h3>Methods</h3> | 69 <h3>Methods</h3> |
| 70 | |
| 60 <table> | 71 <table> |
| 72 | |
| 61 <tr> | 73 <tr> |
| 62 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> | 74 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> |
| 63 <td>Constructor</td> | 75 <td>Constructor</td> |
| 64 </tr><tr> | 76 </tr> |
| 77 <tr> | |
| 65 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> | 78 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> |
| 66 <td>Private method to generate an index file for a package.</td> | 79 <td>Private method to generate an index file for a package.</td> |
| 67 </tr><tr> | 80 </tr> |
| 81 <tr> | |
| 68 <td><a href="#IndexGenerator.remember">remember</a></td> | 82 <td><a href="#IndexGenerator.remember">remember</a></td> |
| 69 <td>Public method to remember a documentation file.</td> | 83 <td>Public method to remember a documentation file.</td> |
| 70 </tr><tr> | 84 </tr> |
| 85 <tr> | |
| 71 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> | 86 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> |
| 72 <td>Public method to generate all index files.</td> | 87 <td>Public method to generate all index files.</td> |
| 73 </tr> | 88 </tr> |
| 74 </table> | 89 </table> |
| 75 <h3>Static Methods</h3> | 90 <h3>Static Methods</h3> |
| 91 | |
| 76 <table> | 92 <table> |
| 77 <tr><td>None</td></tr> | 93 <tr><td>None</td></tr> |
| 78 </table> | 94 </table> |
| 95 | |
| 79 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> | 96 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> |
| 80 <h4>IndexGenerator (Constructor)</h4> | 97 <h4>IndexGenerator (Constructor)</h4> |
| 81 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet=None</i>) | 98 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet=None</i>) |
| 99 | |
| 82 <p> | 100 <p> |
| 83 Constructor | 101 Constructor |
| 84 </p><dl> | 102 </p> |
| 103 <dl> | |
| 104 | |
| 85 <dt><i>outputDir</i></dt> | 105 <dt><i>outputDir</i></dt> |
| 86 <dd> | 106 <dd> |
| 87 The output directory for the files. (string) | 107 The output directory for the files. (string) |
| 88 </dd><dt><i>colors</i></dt> | 108 </dd> |
| 109 <dt><i>colors</i></dt> | |
| 89 <dd> | 110 <dd> |
| 90 Dictionary specifying the various colors for the output. | 111 Dictionary specifying the various colors for the output. |
| 91 (dictionary of strings) | 112 (dictionary of strings) |
| 92 </dd><dt><i>stylesheet</i></dt> | 113 </dd> |
| 114 <dt><i>stylesheet</i></dt> | |
| 93 <dd> | 115 <dd> |
| 94 the style to be used for the generated pages (string) | 116 the style to be used for the generated pages (string) |
| 95 </dd> | 117 </dd> |
| 96 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | 118 </dl> |
| 119 <a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | |
| 97 <h4>IndexGenerator.__writeIndex</h4> | 120 <h4>IndexGenerator.__writeIndex</h4> |
| 98 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) | 121 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) |
| 122 | |
| 99 <p> | 123 <p> |
| 100 Private method to generate an index file for a package. | 124 Private method to generate an index file for a package. |
| 101 </p><dl> | 125 </p> |
| 126 <dl> | |
| 127 | |
| 102 <dt><i>packagename</i></dt> | 128 <dt><i>packagename</i></dt> |
| 103 <dd> | 129 <dd> |
| 104 The name of the package. (string) | 130 The name of the package. (string) |
| 105 </dd><dt><i>package</i></dt> | 131 </dd> |
| 132 <dt><i>package</i></dt> | |
| 106 <dd> | 133 <dd> |
| 107 A dictionary with information about the package. | 134 A dictionary with information about the package. |
| 108 </dd><dt><i>newline</i></dt> | 135 </dd> |
| 136 <dt><i>newline</i></dt> | |
| 109 <dd> | 137 <dd> |
| 110 newline character to be used (string) | 138 newline character to be used (string) |
| 111 </dd> | 139 </dd> |
| 112 </dl><dl> | 140 </dl> |
| 141 <dl> | |
| 113 <dt>Returns:</dt> | 142 <dt>Returns:</dt> |
| 114 <dd> | 143 <dd> |
| 115 The name of the generated index file. | 144 The name of the generated index file. |
| 116 </dd> | 145 </dd> |
| 117 </dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | 146 </dl> |
| 147 <a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | |
| 118 <h4>IndexGenerator.remember</h4> | 148 <h4>IndexGenerator.remember</h4> |
| 119 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | 149 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) |
| 150 | |
| 120 <p> | 151 <p> |
| 121 Public method to remember a documentation file. | 152 Public method to remember a documentation file. |
| 122 </p><dl> | 153 </p> |
| 154 <dl> | |
| 155 | |
| 123 <dt><i>file</i></dt> | 156 <dt><i>file</i></dt> |
| 124 <dd> | 157 <dd> |
| 125 The filename to be remembered. (string) | 158 The filename to be remembered. (string) |
| 126 </dd><dt><i>moduleDocument</i></dt> | 159 </dd> |
| 160 <dt><i>moduleDocument</i></dt> | |
| 127 <dd> | 161 <dd> |
| 128 The ModuleDocument object containing the | 162 The ModuleDocument object containing the |
| 129 information for the file. | 163 information for the file. |
| 130 </dd><dt><i>basename</i></dt> | 164 </dd> |
| 165 <dt><i>basename</i></dt> | |
| 131 <dd> | 166 <dd> |
| 132 The basename of the file hierarchy to be documented. | 167 The basename of the file hierarchy to be documented. |
| 133 The basename is stripped off the filename if it starts with | 168 The basename is stripped off the filename if it starts with |
| 134 the basename. | 169 the basename. |
| 135 </dd> | 170 </dd> |
| 136 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | 171 </dl> |
| 172 <a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | |
| 137 <h4>IndexGenerator.writeIndices</h4> | 173 <h4>IndexGenerator.writeIndices</h4> |
| 138 <b>writeIndices</b>(<i>basename="", newline=None</i>) | 174 <b>writeIndices</b>(<i>basename="", newline=None</i>) |
| 175 | |
| 139 <p> | 176 <p> |
| 140 Public method to generate all index files. | 177 Public method to generate all index files. |
| 141 </p><dl> | 178 </p> |
| 179 <dl> | |
| 180 | |
| 142 <dt><i>basename</i></dt> | 181 <dt><i>basename</i></dt> |
| 143 <dd> | 182 <dd> |
| 144 The basename of the file hierarchy to be documented. | 183 The basename of the file hierarchy to be documented. |
| 145 The basename is stripped off the filename if it starts with | 184 The basename is stripped off the filename if it starts with |
| 146 the basename. | 185 the basename. |
| 147 </dd><dt><i>newline</i></dt> | 186 </dd> |
| 187 <dt><i>newline</i></dt> | |
| 148 <dd> | 188 <dd> |
| 149 newline character to be used (string) | 189 newline character to be used (string) |
| 150 </dd> | 190 </dd> |
| 151 </dl> | 191 </dl> |
| 152 <div align="right"><a href="#top">Up</a></div> | 192 <div align="right"><a href="#top">Up</a></div> |
