mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2024-12-26 13:12:34 +01:00
84 lines
2.9 KiB
Python
84 lines
2.9 KiB
Python
#!/usr/bin/env python2
|
|
|
|
from __future__ import with_statement
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
# Commands instances are converted into SynchronizedAndFirewalled
|
|
from supybot.callbacks import SynchronizedAndFirewalled as Commands
|
|
|
|
validCommandName = re.compile('^[a-z]+$')
|
|
|
|
sys.path.append('/home/progval/workspace/Supybot/Supybot-plugins')
|
|
|
|
def main():
|
|
pluginNames = sys.argv[1:]
|
|
for pluginName in pluginNames:
|
|
supybot = __import__('%s.plugin' % pluginName)
|
|
PluginClass = supybot.plugin.Class
|
|
filename = 'use/plugins/%s.rst' % pluginName.lower()
|
|
try:
|
|
os.unlink(filename)
|
|
except OSError:
|
|
pass
|
|
with open(filename, 'a') as fd:
|
|
fd.write('\n.. _plugin-%s:\n\nThe %s plugin\n' %
|
|
(pluginName.lower(), pluginName))
|
|
fd.write('='*len('The %s plugin' % pluginName))
|
|
fd.write('\n\n')
|
|
writeDoc(PluginClass, fd, pluginName.lower())
|
|
|
|
def writeDoc(PluginClass, fd, prefix):
|
|
prefix += ' '
|
|
for attributeName, attribute in PluginClass.__dict__.items():
|
|
if not callable(attribute):
|
|
continue
|
|
if not validCommandName.match(attributeName):
|
|
continue
|
|
if attributeName == 'die':
|
|
continue
|
|
if isinstance(attribute, Commands):
|
|
writeDoc(attribute, fd, prefix + attributeName)
|
|
else:
|
|
if attribute.__doc__ is None:
|
|
attribute.__doc__ = ''
|
|
syntax = attribute.__doc__.split('\n\n')[0].strip()
|
|
if syntax == 'takes no arguments' or syntax == '' or syntax == '':
|
|
syntax = ''
|
|
else:
|
|
syntax = ' ' + syntax
|
|
args = {
|
|
'prefix_dash': prefix.replace(' ', '-'),
|
|
'command': attributeName, # Does not contain spaces
|
|
'prefix_with_trailing_space': prefix,
|
|
'syntax': syntax,
|
|
'help_string': parseHelpString(attribute.__doc__),
|
|
}
|
|
args['decoration'] = '^'*len('%(prefix_with_trailing_space)s%(command)s%(syntax)s' %
|
|
args)
|
|
fd.write('.. _command-%(prefix_dash)s%(command)s:\n\n'
|
|
'%(prefix_with_trailing_space)s%(command)s%(syntax)s\n'
|
|
'%(decoration)s\n\n'
|
|
'%(help_string)s\n\n' % args)
|
|
|
|
def parseHelpString(string):
|
|
# Remove the syntax
|
|
string = '\n\n'.join(string.split('\n\n')[1:])
|
|
# Remove the starting and ending spaces
|
|
string = '\n'.join([x.strip(' ') for x in string.split('\n')])
|
|
if string.endswith('\n'):
|
|
string = string[0:-1]
|
|
# Put the argument names into italic
|
|
string = re.sub(r'(<[^>]+>)', r'*\1*', string, re.M)
|
|
string = re.sub(r'(--[^ ]+)', r'*\1*', string, re.M)
|
|
# Turn config variable names into refs
|
|
string = re.sub(r'(supybot.[a-zA-Z0-9.]+)', r':ref:`\1`', string, re.M)
|
|
return string
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|
|
|