#!/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 supybot import os import cgi import imp import sys import os.path import textwrap import traceback import conf import debug import callbacks def makePluginDocumentation(filename): print 'Generating documentation for %s' % filename trClasses = { 'lightyellow':'lightgreen', 'lightgreen':'lightyellow' } trClass = 'lightyellow' pluginName = filename.split('.')[0] moduleInfo = imp.find_module(pluginName, conf.pluginDirs) module = imp.load_module(pluginName, *moduleInfo) directory = os.path.join('docs', 'plugins') if not os.path.exists(directory): os.mkdir(directory) if not hasattr(module, 'Class'): print '%s is not a plugin.' % filename return try: plugin = module.Class() except Exception, e: print '%s could not be loaded: %s' % (filename, debug.exnToString(e)) return if isinstance(plugin, callbacks.Privmsg) and not \ isinstance(plugin, callbacks.PrivmsgRegexp): fd = file(os.path.join(directory,'%s.html' % pluginName), 'w') fd.write(textwrap.dedent(""" Documentation for the %s plugin for Supybot

%s



""") % (pluginName, cgi.escape(module.__doc__ or ""))) 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) help = cgi.escape(help) morehelp = cgi.escape(morehelp) trClass = trClasses[trClass] fd.write(textwrap.dedent(""" """) % (trClass, attr, help, morehelp)) fd.write(textwrap.dedent("""
CommandArgs Detailed Help
%s%s%s
""")) if hasattr(module, 'example'): s = module.example.encode('string-escape') s = s.replace('\\n', '\n') s = s.replace("\\'", "'") fd.write(textwrap.dedent("""

Here's an example session with this plugin:

            %s
""") % cgi.escape(s)) fd.write(textwrap.dedent("""
""")) fd.close() if __name__ == '__main__': for directory in conf.pluginDirs: for filename in os.listdir(directory): if filename.endswith('.py') and filename[0].isupper(): makePluginDocumentation(filename) # vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: