Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html
eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.DocumentationTools.IndexGenerator</h1> | |
| 23 <p> | |
| 24 Module implementing the index generator for the builtin documentation | |
| 25 generator. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#IndexGenerator">IndexGenerator</a></td> | |
| 35 <td>Class implementing the index generator for the builtin documentation generator.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="IndexGenerator" ID="IndexGenerator"></a> | |
| 44 <h2>IndexGenerator</h2> | |
| 45 <p> | |
| 46 Class implementing the index generator for the builtin documentation | |
| 47 generator. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 object | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> | |
| 66 <td>Private method to generate an index file for a package.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#IndexGenerator.remember">remember</a></td> | |
| 69 <td>Public method to remember a documentation file.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> | |
| 72 <td>Public method to generate all index files.</td> | |
| 73 </tr> | |
| 74 </table> | |
| 75 <h3>Static Methods</h3> | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> | |
| 80 <h4>IndexGenerator (Constructor)</h4> | |
| 81 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet=None</i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><dl> | |
| 85 <dt><i>outputDir</i></dt> | |
| 86 <dd> | |
| 87 The output directory for the files. (string) | |
| 88 </dd><dt><i>colors</i></dt> | |
| 89 <dd> | |
| 90 Dictionary specifying the various colors for the output. | |
| 91 (dictionary of strings) | |
| 92 </dd><dt><i>stylesheet</i></dt> | |
| 93 <dd> | |
| 94 the style to be used for the generated pages (string) | |
| 95 </dd> | |
| 96 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | |
| 97 <h4>IndexGenerator.__writeIndex</h4> | |
| 98 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) | |
| 99 <p> | |
| 100 Private method to generate an index file for a package. | |
| 101 </p><dl> | |
| 102 <dt><i>packagename</i></dt> | |
| 103 <dd> | |
| 104 The name of the package. (string) | |
| 105 </dd><dt><i>package</i></dt> | |
| 106 <dd> | |
| 107 A dictionary with information about the package. | |
| 108 </dd><dt><i>newline</i></dt> | |
| 109 <dd> | |
| 110 newline character to be used (string) | |
| 111 </dd> | |
| 112 </dl><dl> | |
| 113 <dt>Returns:</dt> | |
| 114 <dd> | |
| 115 The name of the generated index file. | |
| 116 </dd> | |
| 117 </dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | |
| 118 <h4>IndexGenerator.remember</h4> | |
| 119 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 120 <p> | |
| 121 Public method to remember a documentation file. | |
| 122 </p><dl> | |
| 123 <dt><i>file</i></dt> | |
| 124 <dd> | |
| 125 The filename to be remembered. (string) | |
| 126 </dd><dt><i>moduleDocument</i></dt> | |
| 127 <dd> | |
| 128 The ModuleDocument object containing the | |
| 129 information for the file. | |
| 130 </dd><dt><i>basename</i></dt> | |
| 131 <dd> | |
| 132 The basename of the file hierarchy to be documented. | |
| 133 The basename is stripped off the filename if it starts with | |
| 134 the basename. | |
| 135 </dd> | |
| 136 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | |
| 137 <h4>IndexGenerator.writeIndices</h4> | |
| 138 <b>writeIndices</b>(<i>basename="", newline=None</i>) | |
| 139 <p> | |
| 140 Public method to generate all index files. | |
| 141 </p><dl> | |
| 142 <dt><i>basename</i></dt> | |
| 143 <dd> | |
| 144 The basename of the file hierarchy to be documented. | |
| 145 The basename is stripped off the filename if it starts with | |
| 146 the basename. | |
| 147 </dd><dt><i>newline</i></dt> | |
| 148 <dd> | |
| 149 newline character to be used (string) | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <div align="right"><a href="#top">Up</a></div> | |
| 153 <hr /> | |
| 154 </body></html> |
