Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html
eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.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.QScintilla.DocstringGenerator.SphinxdocGenerator</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.QScintilla.DocstringGenerator.SphinxdocGenerator</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the docstring generator for the 'sphinxdoc' style. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#generateSphinxDoc">generateSphinxDoc</a></td> | |
| 44 <td>Function to generate the docstring line list iaw.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="generateSphinxDoc" ID="generateSphinxDoc"></a> | |
| 50 <h2>generateSphinxDoc</h2> | |
| 51 <b>generateSphinxDoc</b>(<i>functionInfo</i>) | |
| 52 | |
| 53 <p> | |
| 54 Function to generate the docstring line list iaw. Sphinx documentation | |
| 55 style. | |
| 56 </p> | |
| 57 <p> | |
| 58 Note: Text is created with DESCRIPTION placeholders for descriptions and | |
| 59 TYPE placeholders for type information | |
| 60 </p> | |
| 61 <dl> | |
| 62 | |
| 63 <dt><i>functionInfo</i> (FunctionInfo)</dt> | |
| 64 <dd> | |
| 65 object containing the function information to base | |
| 66 the docstring on | |
| 67 </dd> | |
| 68 </dl> | |
| 69 <dl> | |
| 70 <dt>Return:</dt> | |
| 71 <dd> | |
| 72 list of docstring lines | |
| 73 </dd> | |
| 74 </dl> | |
| 75 <dl> | |
| 76 <dt>Return Type:</dt> | |
| 77 <dd> | |
| 78 str | |
| 79 </dd> | |
| 80 </dl> | |
| 81 <div align="right"><a href="#top">Up</a></div> | |
| 82 <hr /> | |
| 83 </body></html> |
