Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.DocumentationTools.IndexGenerator.html
Documentation/Source/eric4.DocumentationTools.IndexGenerator.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.DocumentationTools.IndexGenerator</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.DocumentationTools.IndexGenerator</h1> | |
| 24 <p> | |
| 25 Module implementing the index generator for the builtin documentation 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 generator. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 object | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> | |
| 61 <td>Private method to generate an index file for a package.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#IndexGenerator.remember">remember</a></td> | |
| 64 <td>Public method to remember a documentation file.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> | |
| 67 <td>Public method to generate all index files.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> | |
| 71 <h4>IndexGenerator (Constructor)</h4> | |
| 72 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet = None</i>) | |
| 73 <p> | |
| 74 Constructor | |
| 75 </p><dl> | |
| 76 <dt><i>outputDir</i></dt> | |
| 77 <dd> | |
| 78 The output directory for the files. (string) | |
| 79 </dd><dt><i>colors</i></dt> | |
| 80 <dd> | |
| 81 Dictionary specifying the various colors for the output. | |
| 82 (dictionary of strings) | |
| 83 </dd><dt><i>stylesheet</i></dt> | |
| 84 <dd> | |
| 85 the style to be used for the generated pages (string) | |
| 86 </dd> | |
| 87 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | |
| 88 <h4>IndexGenerator.__writeIndex</h4> | |
| 89 <b>__writeIndex</b>(<i>packagename, package</i>) | |
| 90 <p> | |
| 91 Private method to generate an index file for a package. | |
| 92 </p><dl> | |
| 93 <dt><i>packagename</i></dt> | |
| 94 <dd> | |
| 95 The name of the package. (string) | |
| 96 </dd><dt><i>package</i></dt> | |
| 97 <dd> | |
| 98 A dictionary with information about the package. | |
| 99 </dd> | |
| 100 </dl><dl> | |
| 101 <dt>Returns:</dt> | |
| 102 <dd> | |
| 103 The name of the generated index file. | |
| 104 </dd> | |
| 105 </dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | |
| 106 <h4>IndexGenerator.remember</h4> | |
| 107 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 108 <p> | |
| 109 Public method to remember a documentation file. | |
| 110 </p><dl> | |
| 111 <dt><i>file</i></dt> | |
| 112 <dd> | |
| 113 The filename to be remembered. (string) | |
| 114 </dd><dt><i>moduleDocument</i></dt> | |
| 115 <dd> | |
| 116 The ModuleDocument object containing the | |
| 117 information for the file. | |
| 118 </dd><dt><i>basename</i></dt> | |
| 119 <dd> | |
| 120 The basename of the file hierarchy to be documented. | |
| 121 The basename is stripped off the filename if it starts with | |
| 122 the basename. | |
| 123 </dd> | |
| 124 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | |
| 125 <h4>IndexGenerator.writeIndices</h4> | |
| 126 <b>writeIndices</b>(<i>basename = ""</i>) | |
| 127 <p> | |
| 128 Public method to generate all index files. | |
| 129 </p><dl> | |
| 130 <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> | |
| 137 <div align="right"><a href="#top">Up</a></div> | |
| 138 <hr /> | |
| 139 </body></html> |
