Merge pull request #11253 from beeankha/collections_docs_fix_pt2

Update auth_plugin Doc Extension File to Fix Malformed Collections Docs

awx_collection/plugins/doc_fragments/auth_plugin.py

@@ -13,56 +13,61 @@ class ModuleDocFragment(object):
     # Automation Platform Controller documentation fragment
     DOCUMENTATION = r'''
 options:
-    host:
+  host:
-        description: The network address of your Automation Platform Controller host.
+    description: The network address of your Automation Platform Controller host.
-        env:
+    env:
-            - name: CONTROLLER_HOST
+    - name: CONTROLLER_HOST
-            - name: TOWER_HOST
+    - name: TOWER_HOST
-              deprecated:
+    deprecated:
-                removed_from_collection: 'awx.awx.controller'
+    - removed_from_collection: 'awx.awx.controller'
-                removed_in_version: '4.0.0'
+    - removed_in: '4.0.0'
-                alternatives: 'CONTROLLER_HOST'
+    - why: Collection name change
-    username:
+    - alternative: 'CONTROLLER_HOST'
-        description: The user that you plan to use to access inventories on the controller.
+  username:
-        env:
+    description: The user that you plan to use to access inventories on the controller.
-            - name: CONTROLLER_USERNAME
+    env:
-            - name: TOWER_USERNAME
+    - name: CONTROLLER_USERNAME
-              deprecated:
+    - name: TOWER_USERNAME
-                removed_from_collection: 'awx.awx.controller'
+    deprecated:
-                removed_in_version: '4.0.0'
+    - removed_from_collection: 'awx.awx.controller'
-                alternatives: 'CONTROLLER_USERNAME'
+    - removed_in: '4.0.0'
-    password:
+    - why: Collection name change
-        description: The password for your controller user.
+    - alternative: 'CONTROLLER_USERNAME'
-        env:
+  password:
-            - name: CONTROLLER_PASSWORD
+    description: The password for your controller user.
-            - name: TOWER_PASSWORD
+    env:
-              deprecated:
+    - name: CONTROLLER_PASSWORD
-                removed_from_collection: 'awx.awx.controller'
+    - name: TOWER_PASSWORD
-                removed_in_version: '4.0.0'
+    deprecated:
-                alternatives: 'CONTROLLER_PASSWORD'
+    - removed_from_collection: 'awx.awx.controller'
-    oauth_token:
+    - removed_in: '4.0.0'
-        description:
+    - why: Collection name change
-            - The OAuth token to use.
+    - alternative: 'CONTROLLER_PASSWORD'
-        env:
+  oauth_token:
-            - name: CONTROLLER_OAUTH_TOKEN
+    description:
-            - name: TOWER_OAUTH_TOKEN
+    - The OAuth token to use.
-              deprecated:
+    env:
-                removed_from_collection: 'awx.awx.controller'
+    - name: CONTROLLER_OAUTH_TOKEN
-                removed_in_version: '4.0.0'
+    - name: TOWER_OAUTH_TOKEN
-                alternatives: 'CONTROLLER_OAUTH_TOKEN'
+    deprecated:
-    verify_ssl:
+    - removed_from_collection: 'awx.awx.controller'
-        description:
+    - removed_in: '4.0.0'
-            - Specify whether Ansible should verify the SSL certificate of the controller host.
+    - why: Collection name change
-            - Defaults to True, but this is handled by the shared module_utils code
+    - alternative: 'CONTROLLER_OAUTH_TOKEN'
-        type: bool
+  verify_ssl:
-        env:
+    description:
-            - name: CONTROLLER_VERIFY_SSL
+    - Specify whether Ansible should verify the SSL certificate of the controller host.
-            - name: TOWER_VERIFY_SSL
+    - Defaults to True, but this is handled by the shared module_utils code
-              deprecated:
+    type: bool
-                removed_from_collection: 'awx.awx.controller'
+    env:
-                removed_in_version: '4.0.0'
+    - name: CONTROLLER_VERIFY_SSL
-                alternatives: 'CONTROLLER_VERIFY_SSL'
+    - name: TOWER_VERIFY_SSL
-        aliases: [ validate_certs ]
+    deprecated:
+    - removed_from_collection: 'awx.awx.controller'
+    - removed_in: '4.0.0'
+    - why: Collection name change
+    - alternative: 'CONTROLLER_VERIFY_SSL'
+    aliases: [ validate_certs ]
 
 notes:
 - If no I(config_file) is provided we will attempt to use the tower-cli library

awx_collection/plugins/inventory/controller.py

@@ -19,7 +19,6 @@ description:
       the path in the command would be /path/to/controller_inventory.(yml|yaml). If some arguments in the config file
       are missing, this plugin will try to fill in missing arguments by reading from environment variables.
     - If reading configurations from environment variables, the path in the command must be @controller_inventory.
-extends_documentation_fragment: awx.awx.auth_plugin
 options:
     inventory_id:
         description:
@@ -35,6 +34,7 @@ options:
         description: Make extra requests to provide all group vars with metadata about the source host.
         type: bool
         default: False
+extends_documentation_fragment: awx.awx.auth_plugin
 '''
 
 EXAMPLES = '''

awx_collection/plugins/lookup/controller_api.py

@@ -15,7 +15,6 @@ description:
     U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage.
   - For use that is cross-compatible between the awx.awx and ansible.controller collection
     see the controller_meta module
-extends_documentation_fragment: awx.awx.auth_plugin
 options:
   _terms:
     description:
@@ -63,7 +62,7 @@ options:
       - If a list view returns more an max_objects an exception will be raised
     type: integer
     default: 1000
-
+extends_documentation_fragment: awx.awx.auth_plugin
 notes:
   - If the query is not filtered properly this can cause a performance impact.
 """