Startseite Erkunden Hilfe
Anmelden
SleepyHackers
/
sleepermud
Beobachten 2
Favorit hinzufügen 0
Fork 1
Dateien Issues 0 Pull-Requests 0 Wiki
Branch: master
Branches Tags
sleepermud
/
html
/
pydocs
/
doc.html

doc.html 3.9 KB
Permalink Verlauf Originalformat

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 
  1. 

  2. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    3. 

  3. <html><head><title>Python: doc</title>
    4. 

  4. </head><body bgcolor="#f0f0f8">
    5. 

  5. 

  6. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
    7. 

  7. <tr bgcolor="#7799ee">
    8. 

  8. <td valign=bottom>&nbsp;<br>
    9. 

  9. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>doc</strong></big></big></font></td
    10. 

  10. ><td align=right valign=bottom
    11. 

  11. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/hollis/Desktop/nakedmud/lib/pymodules/doc.py">/Users/hollis/Desktop/nakedmud/lib/pymodules/doc.py</a></font></td></tr></table>
    12. 

  12.     <p><tt>doc.py<br>
    13. 

  13. &nbsp;<br>
    14. 

  14. This&nbsp;module&nbsp;allows&nbsp;documentation&nbsp;for&nbsp;Python&nbsp;classes&nbsp;and&nbsp;modules&nbsp;to&nbsp;be&nbsp;viewed<br>
    15. 

  15. in-game&nbsp;via&nbsp;the&nbsp;'doc'&nbsp;command.</tt></p>
    16. 

  16. <p>
    17. 

  17. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    18. 

  18. <tr bgcolor="#aa55cc">
    19. 

  19. <td colspan=3 valign=bottom>&nbsp;<br>
    20. 

  20. <font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    21. 

  21.     
    22. 

  22. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    23. 

  23. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="display.html">display</a><br>
    24. 

  24. </td><td width="25%" valign=top><a href="mudsys.html">mudsys</a><br>
    25. 

  25. </td><td width="25%" valign=top><a href="os.html">os</a><br>
    26. 

  26. </td><td width="25%" valign=top><a href="pydoc.html">pydoc</a><br>
    27. 

  27. </td></tr></table></td></tr></table><p>
    28. 

  28. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    29. 

  29. <tr bgcolor="#eeaa77">
    30. 

  30. <td colspan=3 valign=bottom>&nbsp;<br>
    31. 

  31. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    32. 

  32.     
    33. 

  33. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    34. 

  34. <td width="100%"><dl><dt><a name="-cmd_doc"><strong>cmd_doc</strong></a>(ch, cmd, arg)</dt><dd><tt>Return&nbsp;Python&nbsp;documentation&nbsp;for&nbsp;the&nbsp;specified&nbsp;module,&nbsp;class,&nbsp;function,<br>
    35. 

  35. etc...&nbsp;for&nbsp;example:<br>
    36. 

  36. &nbsp;<br>
    37. 

  37. &gt;&nbsp;doc&nbsp;char.Char<br>
    38. 

  38. &nbsp;<br>
    39. 

  39. Will&nbsp;return&nbsp;all&nbsp;available&nbsp;documentation&nbsp;for&nbsp;the&nbsp;Char&nbsp;class.</tt></dd></dl>
    40. 

  40.  <dl><dt><a name="-cmd_htmldoc"><strong>cmd_htmldoc</strong></a>(ch, cmd, arg)</dt><dd><tt>Creates&nbsp;html&nbsp;documentation&nbsp;for&nbsp;all&nbsp;registered&nbsp;modules.&nbsp;html&nbsp;files&nbsp;will<br>
    41. 

  41. be&nbsp;saved&nbsp;to&nbsp;html/pydocs/</tt></dd></dl>
    42. 

  42.  <dl><dt><a name="-register_module_doc"><strong>register_module_doc</strong></a>(modname, package<font color="#909090">=None</font>, root<font color="#909090">='pymodules'</font>)</dt><dd><tt>Add&nbsp;a&nbsp;new&nbsp;module&nbsp;name&nbsp;to&nbsp;suggested_reading.&nbsp;If&nbsp;modname&nbsp;is&nbsp;a&nbsp;package,<br>
    43. 

  43. recursively&nbsp;add&nbsp;its&nbsp;packages&nbsp;as&nbsp;well</tt></dd></dl>
    44. 

  44. </td></tr></table><p>
    45. 

  45. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    46. 

  46. <tr bgcolor="#55aa55">
    47. 

  47. <td colspan=3 valign=bottom>&nbsp;<br>
    48. 

  48. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    49. 

  49.     
    50. 

  50. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    51. 

  51. <td width="100%"><strong>HTML_DOC_DIR</strong> = '../html/pydocs'<br>
    52. 

  52. <strong>builtins</strong> = ['char', 'room', 'obj', 'exit', 'account', 'mudsock', 'mud', 'mudsys', 'hooks', 'event', 'auxiliary', 'storage', 'olc']<br>
    53. 

  53. <strong>fname</strong> = 'utils.pyc'<br>
    54. 

  54. <strong>mod</strong> = 'olc'<br>
    55. 

  55. <strong>modname</strong> = 'utils'<br>
    56. 

  56. <strong>shortcuts</strong> = {'ch': 'char', 'sock': 'mudsock'}<br>
    57. 

  57. <strong>suggested_reading</strong> = ['char', 'room', 'obj', 'exit', 'account', 'mudsock', 'mud', 'mudsys', 'hooks', 'event', 'auxiliary', 'storage', 'olc', 'account_handler', 'char_gen', 'cmd_admin', 'cmd_comm', 'cmd_inform', 'cmd_manip', 'cmd_misc', ...]</td></tr></table>
    58. 

  58. </body></html>
    59.