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