ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 11:51:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Unified document generator and make to generate JSON and JS files

Browse source
This commit is contained in:
Marco Vito Moscaritolo 2012-10-09 22:04:55 +02:00 • committed by Michael DeHaan
parent 85fb83a5db
commit ee679c0190
51 changed files with 5969 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

46
hacking/module_formatter.py
View file

@ -103,6 +103,12 @@ def json_ify(text):
return t
def js_ify(text):
return text
def man_ify(text):
t = _ITALIC.sub(r'\\fI' + r"\1" + r"\\fR", text)
@ -157,6 +163,16 @@ def get_docstring(filename, verbose=False):
return doc
def return_data(text, args, outputname, module):
if args.output_dir is not None:
f = open(os.path.join(args.output_dir, outputname % module), 'w')
f.write(text)
f.close()
else:
print text
def main():
p = argparse.ArgumentParser(description="Convert Ansible module DOCUMENTATION strings to other formats")
@ -179,7 +195,7 @@ def main():
p.add_argument("-t", "--type",
action='store',
dest='type',
choices=['html', 'latex', 'man', 'rst', 'json'],
choices=['html', 'latex', 'man', 'rst', 'json', 'js'],
default='latex',
help="Output type")
p.add_argument("-m", "--module",
@ -268,11 +284,17 @@ def main():
outputname = "%s.json"
includecmt = ""
includefmt = ""
if args.type == 'js':
env.filters['jpfunc'] = js_ify
template = env.get_template('js.j2')
outputname = "%s.js"
if args.includes_file is not None and includefmt != "":
incfile = open(args.includes_file, "w")
incfile.write(includecmt)
# Temporary variable required to genrate aggregated content in 'js' format.
js_data = []
for module in sorted(os.listdir(args.module_dir)):
if len(args.module_list):
if not module in args.module_list:
@ -286,6 +308,14 @@ def main():
print " processing module source ---> %s" % fname
if args.type == 'js':
if fname.endswith(".json"):
f = open(fname)
j = json.load(f)
f.close()
js_data.append(j)
continue
doc = get_docstring(fname, verbose=args.verbose)
if doc is None and module not in BLACKLIST_MODULES:
@ -314,17 +344,17 @@ def main():
doc['extradata'] = extradata
if args.type == 'json':
doc = { doc['module'] : doc }
text = json.dumps(doc, indent=2)
else:
text = template.render(doc)
if args.output_dir is not None:
f = open(os.path.join(args.output_dir, outputname % module), 'w')
f.write(text)
f.close()
else:
print text
return_data(text, args, outputname, module)
if args.type == 'js':
docs = {}
docs['json'] = json.dumps(js_data, indent=2)
text = template.render(docs)
return_data(text, args, outputname, 'modules')
#def boilerplate():
#