Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.IndexGenerator.html
Documentation/Source/eric5.DocumentationTools.IndexGenerator.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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>eric5.DocumentationTools.IndexGenerator</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.DocumentationTools.IndexGenerator</h1> | |
| 12 <p> | |
| 13 Module implementing the index generator for the builtin documentation generator. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#IndexGenerator">IndexGenerator</a></td> | |
| 23 <td>Class implementing the index generator for the builtin documentation generator.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="IndexGenerator" ID="IndexGenerator"></a> | |
| 32 <h2>IndexGenerator</h2> | |
| 33 <p> | |
| 34 Class implementing the index generator for the builtin documentation generator. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 object | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> | |
| 49 <td>Private method to generate an index file for a package.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#IndexGenerator.remember">remember</a></td> | |
| 52 <td>Public method to remember a documentation file.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> | |
| 55 <td>Public method to generate all index files.</td> | |
| 56 </tr> | |
| 57 </table> | |
| 58 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> | |
| 59 <h4>IndexGenerator (Constructor)</h4> | |
| 60 <b>IndexGenerator</b>(<i>outputDir, colors, stylesheet = None</i>) | |
| 61 <p> | |
| 62 Constructor | |
| 63 </p><dl> | |
| 64 <dt><i>outputDir</i></dt> | |
| 65 <dd> | |
| 66 The output directory for the files. (string) | |
| 67 </dd><dt><i>colors</i></dt> | |
| 68 <dd> | |
| 69 Dictionary specifying the various colors for the output. | |
| 70 (dictionary of strings) | |
| 71 </dd><dt><i>stylesheet</i></dt> | |
| 72 <dd> | |
| 73 the style to be used for the generated pages (string) | |
| 74 </dd> | |
| 75 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | |
| 76 <h4>IndexGenerator.__writeIndex</h4> | |
| 77 <b>__writeIndex</b>(<i>packagename, package</i>) | |
| 78 <p> | |
| 79 Private method to generate an index file for a package. | |
| 80 </p><dl> | |
| 81 <dt><i>packagename</i></dt> | |
| 82 <dd> | |
| 83 The name of the package. (string) | |
| 84 </dd><dt><i>package</i></dt> | |
| 85 <dd> | |
| 86 A dictionary with information about the package. | |
| 87 </dd> | |
| 88 </dl><dl> | |
| 89 <dt>Returns:</dt> | |
| 90 <dd> | |
| 91 The name of the generated index file. | |
| 92 </dd> | |
| 93 </dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | |
| 94 <h4>IndexGenerator.remember</h4> | |
| 95 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 96 <p> | |
| 97 Public method to remember a documentation file. | |
| 98 </p><dl> | |
| 99 <dt><i>file</i></dt> | |
| 100 <dd> | |
| 101 The filename to be remembered. (string) | |
| 102 </dd><dt><i>moduleDocument</i></dt> | |
| 103 <dd> | |
| 104 The ModuleDocument object containing the | |
| 105 information for the file. | |
| 106 </dd><dt><i>basename</i></dt> | |
| 107 <dd> | |
| 108 The basename of the file hierarchy to be documented. | |
| 109 The basename is stripped off the filename if it starts with | |
| 110 the basename. | |
| 111 </dd> | |
| 112 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | |
| 113 <h4>IndexGenerator.writeIndices</h4> | |
| 114 <b>writeIndices</b>(<i>basename = ""</i>) | |
| 115 <p> | |
| 116 Public method to generate all index files. | |
| 117 </p><dl> | |
| 118 <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> | |
| 125 <div align="right"><a href="#top">Up</a></div> | |
| 126 <hr /> | |
| 127 </body></html> |
