Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-07 19:49:23 +01:00
Code Issues Projects Releases Wiki Activity
484bb71b3a
Limnoria/tools/generate-plugin-documentation.py

264 lines
9.6 KiB
Python
Raw Normal View History

Moved from scripts/plugin-documentation.py
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.
###
Minor changes.
2003-10-14 05:55:04 +02:00
import supybot
Moved from scripts/plugin-documentation.py
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
Updated the class names for the table rows
2003-10-20 19:13:40 +02:00
conf.dataDir = 'test-data'
conf.confDir = 'test-conf'
conf.logDir = 'test-log'
Minor changes.
2003-10-14 05:55:04 +02:00
import debug
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
import callbacks
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
commandDict = {}
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
firstChars = {}
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
def genHeader(title, meta=''):
return """
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
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">
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
<title>%s</title>
<link rel="stylesheet" type="text/css" href="http://supybot.sourceforge.net/css/supybot.css">
%s
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
<body><div>
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
""" % (title, meta)
def genFooter():
return """
</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&amp;type=1"
width="88" height="31" alt="SourceForge.net Logo" /></a>
</div>
</body>
</html>
"""
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
<div class="maintitle">Supybot Plugin Documentation Index</div>
<br />
""" % genHeader('Supybot Plugin Documentation')))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd.close()
def makePluginDocumentation(pluginWindow):
global commandDict
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
global firstChars
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
trClasses = { 'even':'odd', 'odd':'even' }
trClass = 'even'
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
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'
supybot.css is in supybot-www now. Major overhaul to docs generator
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:])
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
id = file(os.path.join(directory, 'plugins.html'), 'a')
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
id.write(textwrap.dedent("""
<strong><a href="%s.html">%s</a></strong>
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
""" % (pluginName, cpluginName)))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd = file(os.path.join(directory,'%s.html' % pluginName), 'w')
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
title = 'Documentation for the %s plugin for Supybot' % pluginName
meta = """
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
<link rel="home" title="Plugin Documentation Index" href="index.html">
<link rel="next" href="%s.html">
<link rel="previous" href="%s.html">
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
""" % (next, prev)
fd.write(textwrap.dedent("""
%s
<div class="plugintitle">%s</div><br /><table>
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
<tr id="headers"><td>Command</td><td>Args</td><td>
Detailed Help</td></tr>
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
""") % (genHeader(title, meta), cgi.escape(module.__doc__ or "")))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
attrs = [x for x in dir(plugin) if plugin.isCommand(x) and not
x.startswith('_')]
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
id.write('(%s)<br />\n' % ', '.join(attrs))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
for attr in attrs:
if attr in commandDict:
commandDict[attr].append(pluginName)
else:
commandDict[attr] = [pluginName]
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
if attr[0] not in firstChars:
firstChars[attr[0]] = ''
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
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]
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
fd.write(textwrap.dedent("""
A few more refinements to the documentation
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>
""") % (trClass, attr, attr, attr, help, morehelp))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd.write(textwrap.dedent("""
</table>
"""))
if hasattr(module, 'example'):
s = module.example.encode('string-escape')
s = s.replace('\\n', '\n')
s = s.replace("\\'", "'")
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
fd.write(textwrap.dedent("""
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
<h2><p>Here's an example session with this plugin:</p></h2>
<pre>
%s
</pre>
""") % cgi.escape(s))
fd.write(textwrap.dedent("""
</div>
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
<div style="text-align: center;">
<br />
<a href="%s.html">&lt;- %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 -&gt;</a>
%s
""" % (prev, cprev, next, cnext, genFooter())))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd.close()
id.close()
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
def finishIndex():
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
fd = file(os.path.join(directory, 'plugins.html'), 'a')
fd.write(textwrap.dedent(genFooter()))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd.close()
def makeCommandsIndex():
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
from string import ascii_lowercase
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
global commandDict
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
global firstChars
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
directory = os.path.join('docs', 'plugins')
if not os.path.exists(directory):
os.mkdir(directory)
fd = file(os.path.join(directory, 'commands.html'), 'w')
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
title = 'Supybot Commands Index'
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd.write(textwrap.dedent("""
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
%s
<div class="maintitle">%s</div><br />
<div class="whitebox" style="text-align: center;">
""" % (genHeader(title), title)))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
commands = [c for c in commandDict.iterkeys()]
commands.sort()
A few more refinements to the documentation
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()))
Cleaned up commands.html a little bit using some suggestions from ddipaolo
2003-11-17 21:11:47 +01:00
else:
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
fd.write('%s ' % i.capitalize())
firstChars.clear()
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
fd.write('</div>\n<br />')
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
for command in commands:
c = command[0]
if c not in firstChars:
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
if firstChars:
fd.write('\n</div><br />')
fd.write('\n<div class="whitebox">')
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
firstChars[c] = ''
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
fd.write('<div name="%s" id="%s" class="letter">%s</div>\n' %
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
(c, c, c.capitalize()))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
plugins = commandDict[command]
plugins.sort()
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
fd.write('<strong>%s</strong> (%s)<br />\n' % (command,
A few more refinements to the documentation
2003-11-18 06:11:35 +01:00
', '.join(['<a href="%s.html#%s">%s</a>' % (p,command,p)
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
for p in plugins])))
supybot.css is in supybot-www now. Major overhaul to docs generator
2003-11-20 01:03:26 +01:00
fd.write('\n</div>')
fd.write(textwrap.dedent(genFooter()))
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
fd.close()
def genPlugins():
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
for directory in conf.pluginDirs:
for filename in os.listdir(directory):
Minor changes.
2003-10-14 05:55:04 +02:00
if filename.endswith('.py') and filename[0].isupper():
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
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)
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
Documentation pages now link to each other. There is also an index sorted by plugin (index.html) and an index sorted by command (commands.html)
2003-11-14 19:53:46 +01:00
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()
Moved from scripts/plugin-documentation.py
2003-10-02 07:52:54 +02:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
Reference in New Issue Copy Permalink