ansible/test/integration/targets/ansible-doc/library/test_docs_suboptions.py
Felix Fontein 840d3a9dd7
ansible-doc: properly handle suboptions (#69795)
* Specifically handle suboptions, contains, etc in ansible-doc.
2020-06-08 11:51:33 -04:00

70 lines
1.6 KiB
Python

#!/usr/bin/python
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: test_docs_suboptions
short_description: Test module
description:
- Test module
author:
- Ansible Core Team
options:
with_suboptions:
description:
- An option with suboptions.
- Use with care.
type: dict
suboptions:
z_last:
description: The last suboption.
type: str
m_middle:
description:
- The suboption in the middle.
- Has its own suboptions.
suboptions:
a_suboption:
description: A sub-suboption.
type: str
a_first:
description: The first suboption.
type: str
'''
EXAMPLES = '''
'''
RETURN = '''
'''
from ansible.module_utils.basic import AnsibleModule
def main():
module = AnsibleModule(
argument_spec=dict(
test_docs_suboptions=dict(
type='dict',
options=dict(
a_first=dict(type='str'),
m_middle=dict(
type='dict',
options=dict(
a_suboption=dict(type='str')
),
),
z_last=dict(type='str'),
),
),
),
)
module.exit_json()
if __name__ == '__main__':
main()