Security Automation with Ansible 2

Documenting the module

The module documentation is generated from the module code itself. The DOCUMENTATION docstring is compulsory for the modules to be created now. 

The easiest way to get started is to look at this example: https://github.com/ansible/ansible/blob/devel/examples/DOCUMENTATION.yml.

The list of fields required here are:

• module: Module name
• short_description: Short description
• description: Description
• version_added: Indicated by X.Y
• author: Your name and twitter/GitHub username
• options: Each of the options supported by the module
• notes: Anything else that a module user should be aware of
• requirements: We list additional package requirements

For more details about the fields, visit http://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#fields ...