how to use extends_documentation_fragment. getting error while using it

Archives Ansible Project
1

Hi ,

I am new to ansible and this is my first ansible project. I am writing my own ansible modules which shares the same document acroos multiple modules which i need to develop.
As per the ansible website https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html we can use extends_documentation_fragment.

After going through the web link this is what i did on my centos (ansible controller)

i create a new doc file (alokdoc.py) with below content.

class ModuleDocFragment(object):

DOCUMENTATION = r’‘’
array_ip:
description:

  • “The storage system IP address.”
    required: True
    array_password:
    description:
  • “The storage system password.”
    required: True
    array_username:
    description:
  • “The storage system user name.”
    required: True
    ‘’’

I saved this under the following directory “/usr/lib/python3.6/site-packages/ansible/plugins/doc_fragments” as “alokdoc.py”

Now in my ansible module ,namely, alok_module1.py, located under /etc/ansible/library/modules , i wrote the below

DOCUMENTATION = r’‘’

2

you are missing `options:` in your fragment, you are listing them
directly at top level which won't be understood.

class ModuleDocFragment(object):

    DOCUMENTATION = r'''
options:
    array_ip:
      description:
      - "The storage system IP address."
      required: True
    array_password:
      description:
      - "The storage system password."
      required: True
    array_username:
      description:
      - "The storage system user name."
      required: True
    '''