2003-10-02 07:52:54 +02:00
|
|
|
#!/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.
|
|
|
|
|
###
|
|
|
|
|
|
2003-10-14 05:55:04 +02:00
|
|
|
import supybot
|
|
|
|
|
|
2003-10-02 07:52:54 +02:00
|
|
|
import os
|
|
|
|
|
import cgi
|
|
|
|
|
import imp
|
|
|
|
|
import sys
|
|
|
|
|
import os.path
|
|
|
|
|
import textwrap
|
|
|
|
|
import traceback
|
|
|
|
|
|
|
|
|
|
import conf
|
2003-10-20 19:13:40 +02:00
|
|
|
conf.dataDir = 'test-data'
|
|
|
|
|
conf.confDir = 'test-conf'
|
|
|
|
|
conf.logDir = 'test-log'
|
|
|
|
|
|
2003-10-14 05:55:04 +02:00
|
|
|
import debug
|
2003-10-02 07:52:54 +02:00
|
|
|
import callbacks
|
|
|
|
|
|
2003-11-14 19:53:46 +01:00
|
|
|
commandDict = {}
|
2003-11-18 06:11:35 +01:00
|
|
|
firstChars = {}
|
2003-10-02 07:52:54 +02:00
|
|
|
|
2003-11-20 01:03:26 +01:00
|
|
|
def genHeader(title, meta=''):
|
2003-11-20 01:47:20 +01:00
|
|
|
return '''
|
2003-11-14 19:53:46 +01:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
|
|
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
|
<html lang="en-us">
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
2003-11-20 01:03:26 +01:00
|
|
|
<title>%s</title>
|
2003-11-20 01:46:31 +01:00
|
|
|
<link rel="stylesheet" type="text/css"
|
|
|
|
|
href="http://supybot.sourceforge.net/css/supybot.css">
|
2003-11-20 01:03:26 +01:00
|
|
|
%s
|
2003-11-14 19:53:46 +01:00
|
|
|
<body><div>
|
2003-11-20 01:47:20 +01:00
|
|
|
''' % (title, meta)
|
2003-11-20 01:03:26 +01:00
|
|
|
|
|
|
|
|
def genFooter():
|
2003-11-20 01:47:20 +01:00
|
|
|
return '''
|
2003-11-20 01:03:26 +01:00
|
|
|
</div>
|
|
|
|
|
<div style="text-align: center"><br /><!-- Buttons -->
|
|
|
|
|
<a href="http://validator.w3.org/check/referer"><img
|
|
|
|
|
src="http://www.w3.org/Icons/valid-html401"
|
|
|
|
|
alt="Valid HTML 4.01!" height="31" width="88" /></a>
|
|
|
|
|
|
|
|
|
|
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
|
|
|
|
|
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
|
|
|
|
alt="Valid CSS!" /></a>
|
|
|
|
|
|
|
|
|
|
<a href="http://sourceforge.net"><img
|
|
|
|
|
src="http://sourceforge.net/sflogo.php?group_id=58965&type=1"
|
|
|
|
|
width="88" height="31" alt="SourceForge.net Logo" /></a>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
2003-11-20 01:47:20 +01:00
|
|
|
'''
|
2003-11-20 01:03:26 +01:00
|
|
|
|
|
|
|
|
def prepIndex():
|
|
|
|
|
directory = os.path.join('docs', 'plugins')
|
|
|
|
|
if not os.path.exists(directory):
|
|
|
|
|
os.mkdir(directory)
|
2003-11-20 01:46:31 +01:00
|
|
|
fd = file(os.path.join('docs', 'plugins.html'), 'w')
|
|
|
|
|
fd.write(textwrap.dedent('''
|
2003-11-20 01:03:26 +01:00
|
|
|
%s
|
|
|
|
|
<div class="maintitle">Supybot Plugin Documentation Index</div>
|
|
|
|
|
<br />
|
2003-11-20 01:46:31 +01:00
|
|
|
''' % genHeader('Supybot Plugin Documentation')))
|
2003-11-14 19:53:46 +01:00
|
|
|
fd.close()
|
|
|
|
|
|
|
|
|
|
def makePluginDocumentation(pluginWindow):
|
|
|
|
|
global commandDict
|
2003-11-18 06:11:35 +01:00
|
|
|
global firstChars
|
2003-11-20 01:03:26 +01:00
|
|
|
trClasses = { 'even':'odd', 'odd':'even' }
|
|
|
|
|
trClass = 'even'
|
2003-11-14 19:53:46 +01:00
|
|
|
(pluginName, module, plugin) = pluginWindow[1]
|
|
|
|
|
print 'Generating documentation for %s.py' % pluginName
|
|
|
|
|
prev = pluginWindow[0][0] or 'index'
|
|
|
|
|
next = pluginWindow[2][0] or 'index'
|
2003-11-20 01:03:26 +01:00
|
|
|
# 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:])
|
2003-10-02 07:52:54 +02:00
|
|
|
directory = os.path.join('docs', 'plugins')
|
|
|
|
|
if not os.path.exists(directory):
|
|
|
|
|
os.mkdir(directory)
|
2003-11-20 01:46:31 +01:00
|
|
|
id = file(os.path.join('docs', 'plugins.html'), 'a')
|
|
|
|
|
id.write('<strong><a href="%s.html">%s</a></strong>\n' %
|
|
|
|
|
(pluginName, cpluginName))
|
2003-11-14 19:53:46 +01:00
|
|
|
fd = file(os.path.join(directory,'%s.html' % pluginName), 'w')
|
2003-11-20 01:03:26 +01:00
|
|
|
title = 'Documentation for the %s plugin for Supybot' % pluginName
|
2003-11-20 01:46:31 +01:00
|
|
|
meta = '''
|
2003-11-14 19:53:46 +01:00
|
|
|
<link rel="home" title="Plugin Documentation Index" href="index.html">
|
2003-11-20 01:46:31 +01:00
|
|
|
<link rel="next" href="plugins/%s.html">
|
|
|
|
|
<link rel="previous" href="plugins/%s.html">
|
|
|
|
|
''' % (next, prev)
|
|
|
|
|
fd.write(textwrap.dedent('''
|
2003-11-20 01:03:26 +01:00
|
|
|
%s
|
|
|
|
|
<div class="plugintitle">%s</div><br /><table>
|
2003-11-14 19:53:46 +01:00
|
|
|
<tr id="headers"><td>Command</td><td>Args</td><td>
|
|
|
|
|
Detailed Help</td></tr>
|
2003-11-20 01:46:31 +01:00
|
|
|
''' % (genHeader(title, meta), cgi.escape(module.__doc__ or ""))))
|
2003-11-14 19:53:46 +01:00
|
|
|
attrs = [x for x in dir(plugin) if plugin.isCommand(x) and not
|
|
|
|
|
x.startswith('_')]
|
2003-11-20 01:03:26 +01:00
|
|
|
id.write('(%s)<br />\n' % ', '.join(attrs))
|
2003-11-14 19:53:46 +01:00
|
|
|
for attr in attrs:
|
|
|
|
|
if attr in commandDict:
|
|
|
|
|
commandDict[attr].append(pluginName)
|
|
|
|
|
else:
|
|
|
|
|
commandDict[attr] = [pluginName]
|
2003-11-18 06:11:35 +01:00
|
|
|
if attr[0] not in firstChars:
|
|
|
|
|
firstChars[attr[0]] = ''
|
2003-11-14 19:53:46 +01:00
|
|
|
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]
|
2003-11-20 01:46:31 +01:00
|
|
|
fd.write(textwrap.dedent('''
|
2003-11-18 06:11:35 +01:00
|
|
|
<tr class="%s" name="%s" id="%s"><td>%s</td><td>%s</td>
|
|
|
|
|
<td class="detail">%s</td></tr>
|
2003-11-20 01:46:31 +01:00
|
|
|
''' % (trClass, attr, attr, attr, help, morehelp)))
|
|
|
|
|
fd.write('</table>\n')
|
|
|
|
|
fd.write(textwrap.dedent('''
|
2003-11-14 19:53:46 +01:00
|
|
|
</div>
|
2003-11-20 01:03:26 +01:00
|
|
|
<div style="text-align: center;">
|
|
|
|
|
<br />
|
2003-11-20 02:58:39 +01:00
|
|
|
<a href="%s.html"><- %s</a> |
|
|
|
|
|
<a href="../plugins.html">Plugin Index</a> |
|
|
|
|
|
<a href="../../index.html">Home</a> |
|
|
|
|
|
<a href="../commands.html">Command Index</a> |
|
|
|
|
|
<a href="%s.html">%s -></a>
|
2003-11-20 01:03:26 +01:00
|
|
|
%s
|
2003-11-20 01:46:31 +01:00
|
|
|
''' % (prev, cprev, next, cnext, genFooter())))
|
2003-11-14 19:53:46 +01:00
|
|
|
fd.close()
|
|
|
|
|
id.close()
|
2003-10-02 07:52:54 +02:00
|
|
|
|
2003-11-14 19:53:46 +01:00
|
|
|
def finishIndex():
|
2003-11-20 01:46:31 +01:00
|
|
|
directory = 'docs'
|
2003-11-14 19:53:46 +01:00
|
|
|
if not os.path.exists(directory):
|
|
|
|
|
os.mkdir(directory)
|
2003-11-20 01:03:26 +01:00
|
|
|
fd = file(os.path.join(directory, 'plugins.html'), 'a')
|
|
|
|
|
fd.write(textwrap.dedent(genFooter()))
|
2003-11-14 19:53:46 +01:00
|
|
|
fd.close()
|
|
|
|
|
|
|
|
|
|
def makeCommandsIndex():
|
2003-11-18 06:11:35 +01:00
|
|
|
from string import ascii_lowercase
|
2003-11-14 19:53:46 +01:00
|
|
|
global commandDict
|
2003-11-18 06:11:35 +01:00
|
|
|
global firstChars
|
2003-11-20 01:46:31 +01:00
|
|
|
directory = 'docs'
|
2003-11-14 19:53:46 +01:00
|
|
|
if not os.path.exists(directory):
|
|
|
|
|
os.mkdir(directory)
|
|
|
|
|
fd = file(os.path.join(directory, 'commands.html'), 'w')
|
2003-11-20 01:03:26 +01:00
|
|
|
title = 'Supybot Commands Index'
|
2003-11-20 01:46:31 +01:00
|
|
|
fd.write(textwrap.dedent('''
|
2003-11-20 01:03:26 +01:00
|
|
|
%s
|
|
|
|
|
<div class="maintitle">%s</div><br />
|
|
|
|
|
<div class="whitebox" style="text-align: center;">
|
2003-11-20 01:46:31 +01:00
|
|
|
''' % (genHeader(title), title)))
|
2003-11-14 19:53:46 +01:00
|
|
|
commands = [c for c in commandDict.iterkeys()]
|
|
|
|
|
commands.sort()
|
2003-11-18 06:11:35 +01:00
|
|
|
for i in ascii_lowercase:
|
|
|
|
|
if i in firstChars:
|
|
|
|
|
fd.write('<a href="#%s">%s</a> ' % (i, i.capitalize()))
|
2003-11-17 21:11:47 +01:00
|
|
|
else:
|
2003-11-18 06:11:35 +01:00
|
|
|
fd.write('%s ' % i.capitalize())
|
|
|
|
|
firstChars.clear()
|
2003-11-20 01:03:26 +01:00
|
|
|
fd.write('</div>\n<br />')
|
2003-11-20 01:46:31 +01:00
|
|
|
pluginLink = '<a href="plugins/%s.html#%s">%s</a>'
|
2003-11-18 06:11:35 +01:00
|
|
|
for command in commands:
|
|
|
|
|
c = command[0]
|
|
|
|
|
if c not in firstChars:
|
2003-11-20 01:03:26 +01:00
|
|
|
if firstChars:
|
|
|
|
|
fd.write('\n</div><br />')
|
|
|
|
|
fd.write('\n<div class="whitebox">')
|
2003-11-18 06:11:35 +01:00
|
|
|
firstChars[c] = ''
|
2003-11-20 01:03:26 +01:00
|
|
|
fd.write('<div name="%s" id="%s" class="letter">%s</div>\n' %
|
2003-11-18 06:11:35 +01:00
|
|
|
(c, c, c.capitalize()))
|
2003-11-14 19:53:46 +01:00
|
|
|
plugins = commandDict[command]
|
|
|
|
|
plugins.sort()
|
2003-11-20 01:46:31 +01:00
|
|
|
fd.write('<strong>%s</strong> (%s)<br />\n' %
|
|
|
|
|
(command,
|
|
|
|
|
', '.join([pluginLink % (p,command,p) for p in plugins])))
|
2003-11-20 01:03:26 +01:00
|
|
|
fd.write('\n</div>')
|
|
|
|
|
fd.write(textwrap.dedent(genFooter()))
|
2003-11-14 19:53:46 +01:00
|
|
|
fd.close()
|
|
|
|
|
|
|
|
|
|
def genPlugins():
|
2003-10-02 07:52:54 +02:00
|
|
|
for directory in conf.pluginDirs:
|
|
|
|
|
for filename in os.listdir(directory):
|
2003-10-14 05:55:04 +02:00
|
|
|
if filename.endswith('.py') and filename[0].isupper():
|
2003-11-14 19:53:46 +01:00
|
|
|
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)
|
2003-10-02 07:52:54 +02:00
|
|
|
|
2003-11-14 19:53:46 +01:00
|
|
|
if __name__ == '__main__':
|
|
|
|
|
prepIndex()
|
|
|
|
|
plugins = [p for p in genPlugins()]
|
|
|
|
|
plugins.sort()
|
2003-11-20 02:58:39 +01:00
|
|
|
plugins.insert(0, [None])
|
|
|
|
|
plugins.append([None])
|
2003-11-14 19:53:46 +01:00
|
|
|
for pluginWindow in window(plugins, 3):
|
|
|
|
|
makePluginDocumentation(pluginWindow)
|
|
|
|
|
finishIndex()
|
|
|
|
|
makeCommandsIndex()
|
|
|
|
|
|
2003-10-02 07:52:54 +02:00
|
|
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|
|
|
|
|
|
