autotest: added generation of Parameters.html for wordpress

this generates APM docs for wordpress
This commit is contained in:
Andrew Tridgell 2013-05-27 08:25:24 +10:00
parent 767d9d0eb5
commit d510f8f722
2 changed files with 66 additions and 0 deletions

View File

@ -0,0 +1,64 @@
#!/usr/bin/env python
import re
from param import *
from emit import Emit
# Emit docs in a form acceptable to the APM wordpress docs site
class HtmlEmit(Emit):
def __init__(self):
html_fname = 'Parameters.html'
self.f = open(html_fname, mode='w')
self.preamble = '''<!-- Dynamically generated list of documented parameters
This page was generated using Tools/autotest/param_metadata/param_parse.py
DO NOT EDIT
-->
<!-- add auto-generated table of contents with "Table of Contents Plus" plugin -->
[toc]\n
'''
self.t = ''
def escape(self, s):
s = s.replace(' ', '-')
s = s.replace(':', '-')
s = s.replace('(', '')
s = s.replace(')', '')
return s
def close(self):
self.f.write(self.preamble)
self.f.write(self.t)
self.f.close()
def start_libraries(self):
self.t += '\n\n<h1>Libraries</h1>\n\n'
def emit(self, g, f):
tag = '%s Parameters' % g.name
t = '\n\n<h1>%s</h1>\n' % tag
for param in g.params:
if not hasattr(param, 'DisplayName') or not hasattr(param, 'Description'):
continue
tag = '%s (%s)' % (param.DisplayName, param.name)
t += '\n\n<h2>%s</h2>' % tag
t += "\n\n<p>%s</p>\n" % param.Description
t += "<ul>\n"
for field in param.__dict__.keys():
if field not in ['name', 'DisplayName', 'Description', 'User'] and field in known_param_fields:
if field == 'Values' and Emit.prog_values_field.match(param.__dict__[field]):
values = (param.__dict__[field]).split(',')
t += "<table><th>Value</th><th>Meaning</th>\n"
for value in values:
v = value.split(':')
t += "<tr><td>%s</td><td>%s</td></tr>\n" % (v[0], v[1])
t += "</table>\n"
else:
t += "<li>%s: %s</li>\n" % (field, param.__dict__[field])
t += "</ul>\n"
self.t += t

View File

@ -5,6 +5,7 @@ import os, glob, re, sys
from param import *
from wikiemit import WikiEmit
from xmlemit import XmlEmit
from htmlemit import HtmlEmit
from optparse import OptionParser
parser = OptionParser("param_parse.py [options]")
@ -143,5 +144,6 @@ for library in libraries:
do_emit(XmlEmit())
do_emit(WikiEmit())
do_emit(HtmlEmit())
sys.exit(error_count)