It doesn't work, but maybe someone can find the bug. I can't.

2003-08-30 19:42:42 +00:00 · 2003-08-30 19:42:42 +00:00 · 26f28e52d7
parent bf5d0aa30b
commit 26f28e52d7
1 changed files with 106 additions and 0 deletions
--- a/scripts/plugin-documentation.py
+++ b/scripts/plugin-documentation.py
@ -0,0 +1,106 @@
+#!/usr/bin/env python
+
+###
+# Copyright (c) 2002, Jeremiah Fincher
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+
+import os
+import imp
+import sys
+import os.path
+import textwrap
+import traceback
+
+if 'src' not in sys.path:
+    sys.path.insert(0, 'src')
+
+from fix import *
+
+import conf
+import callbacks
+
+if conf.pluginDir not in sys.path:
+    sys.path.insert(0, conf.pluginDir)
+
+def makePluginDocumentation(filename):
+    pluginName = filename.split('.')[0]
+    moduleInfo = imp.find_module(pluginName)
+##     try:
+    module = imp.load_module(filename, *moduleInfo)
+##     except ImportError, e:
+##         print >>sys.stderr, "Plugin %s could not be imported:" % filename
+##         print >>sys.stderr, e
+##         return
+    if not os.path.exists('plugindocs'):
+        os.mkdir('plugindocs')
+    plugin = module.Class()
+    if isinstance(plugin, callbacks.Privmsg) and not \
+       isinstance(plugin, callbacks.PrivmsgRegexp):
+        fd = file('plugindocs/%s.html' % pluginName, 'w')
+        fd.write(textwrap.dedent("""
+        <html><title>Documentation for the %s plugin for Supybot</title>
+        <body>
+        <table><tr><td>Command</td><td>Args</td><td>Detailed Help</td></tr>
+        """) % pluginName)
+        for attr in dir(plugin):
+            if plugin.isCommand(attr):
+                method = getattr(plugin, attr)
+                if hasattr(method, '__doc__'):
+                    doclines = method.__doc__.splitlines()
+                    help = doclines.pop(0)
+                    morehelp = 'This command has no detailed help.'
+                    if doclines:
+                        doclines = filter(None, doclines)
+                        doclines = map(str.strip, doclines)
+                        morehelp = ' '.join(doclines)
+                    fd.write(textwrap.dedent("""
+                    <tr><td>%s</td><td>%s</td><td>%s</td></tr>
+                    """) % (attr, help, morehelp))
+        fd.write(textwrap.dedent("""
+        </table>
+        """))
+        if hasattr(module, 'example'):
+            fd.write(textwrap.dedent("""
+            <p>Here's an example session with this plugin:
+            <pre>
+            %s
+            </pre>
+            </p>
+            """) % module.example)
+        fd.close()
+
+if __name__ == '__main__':
+    for filename in os.listdir(conf.pluginDir):
+        if filename.endswith('.py') and filename.lower() != filename:
+            makePluginDocumentation(filename)
+            
+    
+
+
+# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
+