#!/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
conf.dataDir = 'test-data'
conf.confDir = 'test-conf'
conf.logDir = 'test-log'
import debug
import callbacks
commandDict = {}
firstChars = {}
def genHeader(title, meta=''):
return """
%s
%s
""" % (title, meta)
def genFooter():
return """
"""
def prepIndex():
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
fd = file(os.path.join(directory, 'plugins.html'), 'w')
fd.write(textwrap.dedent("""
%s
Supybot Plugin Documentation Index
""" % genHeader('Supybot Plugin Documentation')))
fd.close()
def makePluginDocumentation(pluginWindow):
global commandDict
global firstChars
trClasses = { 'even':'odd', 'odd':'even' }
trClass = 'even'
(pluginName, module, plugin) = pluginWindow[1]
print 'Generating documentation for %s.py' % pluginName
prev = pluginWindow[0][0] or 'index'
next = pluginWindow[2][0] or 'index'
# can't use string.capitalize() because it lowercases every character
# except the first. must create our own capitalized names
cpluginName = '%s%s' % (pluginName[0].upper(), pluginName[1:])
cprev = '%s%s' % (prev[0].upper(), prev[1:])
cnext = '%s%s' % (next[0].upper(), next[1:])
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
id = file(os.path.join(directory, 'plugins.html'), 'a')
id.write(textwrap.dedent("""
%s
""" % (pluginName, cpluginName)))
fd = file(os.path.join(directory,'%s.html' % pluginName), 'w')
title = 'Documentation for the %s plugin for Supybot' % pluginName
meta = """
""" % (next, prev)
fd.write(textwrap.dedent("""
%s
%s
Command
Args
Detailed Help
""") % (genHeader(title, meta), cgi.escape(module.__doc__ or "")))
attrs = [x for x in dir(plugin) if plugin.isCommand(x) and not
x.startswith('_')]
id.write('(%s) \n' % ', '.join(attrs))
for attr in attrs:
if attr in commandDict:
commandDict[attr].append(pluginName)
else:
commandDict[attr] = [pluginName]
if attr[0] not in firstChars:
firstChars[attr[0]] = ''
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("""
"""))
if hasattr(module, 'example'):
s = module.example.encode('string-escape')
s = s.replace('\\n', '\n')
s = s.replace("\\'", "'")
fd.write(textwrap.dedent("""
<- %s | Plugin Index |
Home | Command Index
| %s ->
%s
""" % (prev, cprev, next, cnext, genFooter())))
fd.close()
id.close()
def finishIndex():
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
fd = file(os.path.join(directory, 'plugins.html'), 'a')
fd.write(textwrap.dedent(genFooter()))
fd.close()
def makeCommandsIndex():
from string import ascii_lowercase
global commandDict
global firstChars
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
fd = file(os.path.join(directory, 'commands.html'), 'w')
title = 'Supybot Commands Index'
fd.write(textwrap.dedent("""
%s
%s
""" % (genHeader(title), title)))
commands = [c for c in commandDict.iterkeys()]
commands.sort()
for i in ascii_lowercase:
if i in firstChars:
fd.write('%s ' % (i, i.capitalize()))
else:
fd.write('%s ' % i.capitalize())
firstChars.clear()
fd.write('
\n ')
for command in commands:
c = command[0]
if c not in firstChars:
if firstChars:
fd.write('\n
')
fd.write('\n
')
firstChars[c] = ''
fd.write('
%s
\n' %
(c, c, c.capitalize()))
plugins = commandDict[command]
plugins.sort()
fd.write('%s (%s) \n' % (command,
', '.join(['%s' % (p,command,p)
for p in plugins])))
fd.write('\n
')
fd.write(textwrap.dedent(genFooter()))
fd.close()
def genPlugins():
for directory in conf.pluginDirs:
for filename in os.listdir(directory):
if filename.endswith('.py') and filename[0].isupper():
pluginName = filename.split('.')[0]
moduleInfo = imp.find_module(pluginName, conf.pluginDirs)
module = imp.load_module(pluginName, *moduleInfo)
if not hasattr(module, 'Class'):
print '%s is not a plugin.' % filename
continue
try:
plugin = module.Class()
except Exception, e:
print '%s could not be loaded: %s' % (filename,
debug.exnToString(e))
continue
if isinstance(plugin, callbacks.Privmsg) and not \
isinstance(plugin, callbacks.PrivmsgRegexp):
yield (pluginName, module, plugin)
if __name__ == '__main__':
prepIndex()
plugins = [p for p in genPlugins()]
plugins.sort()
plugins = [(None,)] + plugins + [(None,)]
for pluginWindow in window(plugins, 3):
makePluginDocumentation(pluginWindow)
finishIndex()
makeCommandsIndex()
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
