mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
e07cbb033f
* Fixup keyword dumping * Clarify introductory text * Turn links in the keyword description into seealso entries in the rst. * Have plugin_formatter cleanup trailing whitespace The indent filter in jinja2 < 2.10 indents blank lines by default which leads to trailing whitespace. Cleanup after that filter. * Edits * Copy edit
78 lines
2.7 KiB
Python
Executable file
78 lines
2.7 KiB
Python
Executable file
#!/usr/bin/env python
|
|
|
|
import optparse
|
|
import re
|
|
from distutils.version import LooseVersion
|
|
|
|
import jinja2
|
|
import yaml
|
|
from jinja2 import Environment, FileSystemLoader
|
|
|
|
from ansible.playbook import Play
|
|
from ansible.playbook.block import Block
|
|
from ansible.playbook.role import Role
|
|
from ansible.playbook.task import Task
|
|
|
|
template_file = 'playbooks_keywords.rst.j2'
|
|
oblist = {}
|
|
clist = []
|
|
class_list = [Play, Role, Block, Task]
|
|
|
|
p = optparse.OptionParser(
|
|
version='%prog 1.0',
|
|
usage='usage: %prog [options]',
|
|
description='Generate playbook keyword documentation from code and descriptions',
|
|
)
|
|
p.add_option("-T", "--template-dir", action="store", dest="template_dir", default="../templates", help="directory containing Jinja2 templates")
|
|
p.add_option("-o", "--output-dir", action="store", dest="output_dir", default='/tmp/', help="Output directory for rst files")
|
|
p.add_option("-d", "--docs-source", action="store", dest="docs", default=None, help="Source for attribute docs")
|
|
|
|
(options, args) = p.parse_args()
|
|
|
|
for aclass in class_list:
|
|
aobj = aclass()
|
|
name = type(aobj).__name__
|
|
|
|
if options.docs:
|
|
with open(options.docs) as f:
|
|
docs = yaml.safe_load(f)
|
|
else:
|
|
docs = {}
|
|
|
|
# build ordered list to loop over and dict with attributes
|
|
clist.append(name)
|
|
oblist[name] = dict((x, aobj.__dict__['_attributes'][x]) for x in aobj.__dict__['_attributes'] if 'private' not in x or not x.private)
|
|
|
|
# pick up docs if they exist
|
|
for a in oblist[name]:
|
|
if a in docs:
|
|
oblist[name][a] = docs[a]
|
|
else:
|
|
oblist[name][a] = ' UNDOCUMENTED!! '
|
|
|
|
# loop is really with_ for users
|
|
if name == 'Task':
|
|
oblist[name]['with_<lookup_plugin>'] = 'DEPRECATED: use ``loop`` instead, with_ used to be how loops were defined, '
|
|
'it can use any available lookup plugin to generate the item list'
|
|
|
|
# local_action is implicit with action
|
|
if 'action' in oblist[name]:
|
|
oblist[name]['local_action'] = 'Same as action but also implies ``delegate_to: localhost``'
|
|
|
|
# remove unusable (used to be private?)
|
|
for nouse in ('loop_args'):
|
|
if nouse in oblist[name]:
|
|
del oblist[name][nouse]
|
|
|
|
env = Environment(loader=FileSystemLoader(options.template_dir), trim_blocks=True,)
|
|
template = env.get_template(template_file)
|
|
outputname = options.output_dir + template_file.replace('.j2', '')
|
|
tempvars = {'oblist': oblist, 'clist': clist}
|
|
|
|
keyword_page = template.render(tempvars)
|
|
if LooseVersion(jinja2.__version__) < LooseVersion('2.10'):
|
|
# jinja2 < 2.10's indent filter indents blank lines. Cleanup
|
|
keyword_page = re.sub(' +\n', '\n', keyword_page)
|
|
|
|
with open(outputname, 'w') as f:
|
|
f.write(keyword_page)
|