[Documentation] Modify template generation to allow for attributes to be used. (#1963)

* Update docs

* Added attribute generation

* Updated docs

* Updated zos_copy rst

* Updated the js2 template

* Updated zos_copy

* Updated script to add attributes section

* Updated module template generation

* Updated rst

* Updated rst

* Updated zos_script with attributes

* Updated docs

* Updated zos_copy

* Updated script rst

* Added changelog

* Modified templates

* Updated zos_script

* Updated zos_script rst

* Updated templates generation

Author: fernandofloresg

changelogs/fragments/1963-support-attributes-docs.yml

@@ -0,0 +1,3 @@
+trivial:
+  - docs/templates/module.rst.j2 - Adds support for including `attributes` keyword inside module's documentation.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1963).

docs/source/modules/zos_script.rst

@@ -243,6 +243,23 @@ template_parameters
 
 
 
+Attributes
+----------
+action
+  | **support**: full
+  | **description**: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+async
+  | **support**: full
+  | **description**: Supports being used with the ``async`` keyword.
+check_mode
+  | **support**: none
+  | **description**: Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.
+diff_mode
+  | **support**: none
+  | **description**: Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.
+
+
+
 Examples
 --------
 

docs/templates/module.rst.j2

@@ -86,6 +86,21 @@ Parameters
 {{ option_generation(options, 0) }}
 {% endif %}
 
+{# ------------------------------------------------------------- #}
+{# Generate the attributes doc                                      #}
+{# ------------------------------------------------------------- #}
+
+{% if attributes -%}
+Attributes
+----------
+{% for name, spec in attributes.items() %}
+{{ name }}
+  | **support**: {{ spec.support}}
+  | **description**: {{ spec.description }}
+{% endfor %}
+
+{% endif %}
+
 {# ------------------------------------------------------------- #}
 {# Generate the sample doc                                       #}
 {# ------------------------------------------------------------- #}

plugins/modules/zos_script.py

@@ -96,6 +96,20 @@
 extends_documentation_fragment:
   - ibm.ibm_zos_core.template
 
+attributes:
+  action:
+    support: full
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.
+  diff_mode:
+    support: none
+    description: Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.
+
 notes:
   - When executing local scripts, temporary storage will be used
     on the remote z/OS system. The size of the temporary storage will