cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix keyword doc generation

Browse source 
* use aliases when they exist
  * fix hardcoded loop attributes handling
This commit is contained in:
Brian Coca 2018-04-30 11:41:52 -04:00 committed by Brian Coca
parent c0cea32f61
commit 19fee0ef41
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/bin/dump_keywords.py
View file

@ -48,19 +48,24 @@ for aclass in class_list:
if a in docs: if a in docs:
oblist[name][a] = docs[a] oblist[name][a] = docs[a]
else: else:
oblist[name][a] = ' UNDOCUMENTED!! ' # check if there is an alias, otherwise undocumented
alias = getattr(getattr(aobj, '_%s' % a), 'alias', None)
if alias and alias in docs:
oblist[name][alias] = docs[alias]
del oblist[name][a]
else:
oblist[name][a] = ' UNDOCUMENTED!! '
# loop is really with_ for users # loop is really with_ for users
if name == 'Task': if name == 'Task':
oblist[name]['with_<lookup_plugin>'] = 'DEPRECATED: use ``loop`` instead, ``with_`` used to be how loops were defined, ' oblist[name]['with_<lookup_plugin>'] = 'The same as ``loop`` but magically adds the output of any lookup plugin to generate the item list.'
'it can use any available lookup plugin to generate the item list'
# local_action is implicit with action # local_action is implicit with action
if 'action' in oblist[name]: if 'action' in oblist[name]:
oblist[name]['local_action'] = 'Same as action but also implies ``delegate_to: localhost``' oblist[name]['local_action'] = 'Same as action but also implies ``delegate_to: localhost``'
# remove unusable (used to be private?) # remove unusable (used to be private?)
for nouse in ('loop_args'): for nouse in ('loop_args', 'loop_with'):
if nouse in oblist[name]: if nouse in oblist[name]:
del oblist[name][nouse] del oblist[name][nouse]