<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: doc</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>doc</strong></big></big></font></td
><td align=right valign=bottom
><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>
<p><tt>doc.py<br>
<br>
This module allows documentation for Python classes and modules to be viewed<br>
in-game via the 'doc' command.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="display.html">display</a><br>
</td><td width="25%" valign=top><a href="mudsys.html">mudsys</a><br>
</td><td width="25%" valign=top><a href="os.html">os</a><br>
</td><td width="25%" valign=top><a href="pydoc.html">pydoc</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-cmd_doc"><strong>cmd_doc</strong></a>(ch, cmd, arg)</dt><dd><tt>Return Python documentation for the specified module, class, function,<br>
etc... for example:<br>
<br>
> doc char.Char<br>
<br>
Will return all available documentation for the Char class.</tt></dd></dl>
<dl><dt><a name="-cmd_htmldoc"><strong>cmd_htmldoc</strong></a>(ch, cmd, arg)</dt><dd><tt>Creates html documentation for all registered modules. html files will<br>
be saved to html/pydocs/</tt></dd></dl>
<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 a new module name to suggested_reading. If modname is a package,<br>
recursively add its packages as well</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>HTML_DOC_DIR</strong> = '../html/pydocs'<br>
<strong>builtins</strong> = ['char', 'room', 'obj', 'exit', 'account', 'mudsock', 'mud', 'mudsys', 'hooks', 'event', 'auxiliary', 'storage', 'olc']<br>
<strong>fname</strong> = 'utils.pyc'<br>
<strong>mod</strong> = 'olc'<br>
<strong>modname</strong> = 'utils'<br>
<strong>shortcuts</strong> = {'ch': 'char', 'sock': 'mudsock'}<br>
<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>
</body></html>