Reformat documentation with 'andebox yaml-doc'. (#216)

plugins/doc_fragments/attributes.py

@@ -11,14 +11,14 @@
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options: {}
 attributes:
-    check_mode:
-      description: Can run in C(check_mode) and return changed status prediction without modifying target.
-    diff_mode:
-      description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
-'''
+  check_mode:
+    description: Can run in C(check_mode) and return changed status prediction without modifying target.
+  diff_mode:
+    description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
+"""
 
     # Should be used together with the standard fragment
     INFO_MODULE = r'''
@@ -34,12 +34,12 @@ class ModuleDocFragment(object):
         - This action does not modify state.
 '''
 
-    FACTS = r'''
+    FACTS = r"""
 options: {}
 attributes:
-    facts:
-      description: Action returns an C(ansible_facts) dictionary that will update existing host facts.
-'''
+  facts:
+    description: Action returns an C(ansible_facts) dictionary that will update existing host facts.
+"""
 
     # Should be used together with the standard fragment and the FACTS fragment
     FACTS_MODULE = r'''
@@ -57,18 +57,18 @@ class ModuleDocFragment(object):
       support: full
 '''
 
-    FILES = r'''
+    FILES = r"""
 options: {}
 attributes:
-    safe_file_operations:
-      description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption.
-'''
+  safe_file_operations:
+    description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption.
+"""
 
-    FLOW = r'''
+    FLOW = r"""
 options: {}
 attributes:
-    action:
-      description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
-    async:
-      description: Supports being used with the C(async) keyword.
-'''
+  action:
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    description: Supports being used with the C(async) keyword.
+"""

plugins/doc_fragments/sops.py

@@ -9,83 +9,78 @@
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 requirements:
-  - A binary executable C(sops) (U(https://github.com/getsops/sops)) must exist either in E(PATH) or configured as
-    O(sops_binary).
+  - A binary executable C(sops) (U(https://github.com/getsops/sops)) must exist either in E(PATH) or configured as O(sops_binary).
 options:
-    sops_binary:
-        description:
-            - Path to the SOPS binary.
-            - By default uses C(sops).
-        type: path
-        version_added: 1.0.0
-    age_key:
-        description:
-            - One or more age private keys that can be used to decrypt encrypted files.
-            - Will be set as the E(SOPS_AGE_KEY) environment variable when calling SOPS.
-            - Requires SOPS 3.7.1+.
-        type: str
-        version_added: 1.4.0
-    age_keyfile:
-        description:
-            - The file containing the age private keys that SOPS can use to decrypt
-              encrypted files.
-            - Will be set as the E(SOPS_AGE_KEY_FILE) environment variable when calling SOPS.
-            - By default, SOPS looks for C(sops/age/keys.txt) inside your user configuration
-              directory.
-            - Requires SOPS 3.7.0+.
-        type: path
-        version_added: 1.4.0
-    aws_profile:
-        description:
-            - The AWS profile to use for requests to AWS.
-            - This corresponds to the SOPS C(--aws-profile) option.
-        type: str
-        version_added: 1.0.0
-    aws_access_key_id:
-        description:
-            - The AWS access key ID to use for requests to AWS.
-            - Sets the environment variable E(AWS_ACCESS_KEY_ID) for the SOPS call.
-        type: str
-        version_added: 1.0.0
-    aws_secret_access_key:
-        description:
-            - The AWS secret access key to use for requests to AWS.
-            - Sets the environment variable E(AWS_SECRET_ACCESS_KEY) for the SOPS call.
-        type: str
-        version_added: 1.0.0
-    aws_session_token:
-        description:
-            - The AWS session token to use for requests to AWS.
-            - Sets the environment variable E(AWS_SESSION_TOKEN) for the SOPS call.
-        type: str
-        version_added: 1.0.0
-    config_path:
-        description:
-            - Path to the SOPS configuration file.
-            - If not set, SOPS will recursively search for the config file starting at
-              the file that is encrypted or decrypted.
-            - This corresponds to the SOPS C(--config) option.
-        type: path
-        version_added: 1.0.0
-    enable_local_keyservice:
-        description:
-            - Tell SOPS to use local key service.
-            - This corresponds to the SOPS C(--enable-local-keyservice) option.
-        type: bool
-        default: false
-        version_added: 1.0.0
-    keyservice:
-        description:
-            - Specify key services to use next to the local one.
-            - A key service must be specified in the form C(protocol://address), for
-              example C(tcp://myserver.com:5000).
-            - This corresponds to the SOPS C(--keyservice) option.
-        type: list
-        elements: str
-        version_added: 1.0.0
-'''
+  sops_binary:
+    description:
+      - Path to the SOPS binary.
+      - By default uses C(sops).
+    type: path
+    version_added: 1.0.0
+  age_key:
+    description:
+      - One or more age private keys that can be used to decrypt encrypted files.
+      - Will be set as the E(SOPS_AGE_KEY) environment variable when calling SOPS.
+      - Requires SOPS 3.7.1+.
+    type: str
+    version_added: 1.4.0
+  age_keyfile:
+    description:
+      - The file containing the age private keys that SOPS can use to decrypt encrypted files.
+      - Will be set as the E(SOPS_AGE_KEY_FILE) environment variable when calling SOPS.
+      - By default, SOPS looks for C(sops/age/keys.txt) inside your user configuration directory.
+      - Requires SOPS 3.7.0+.
+    type: path
+    version_added: 1.4.0
+  aws_profile:
+    description:
+      - The AWS profile to use for requests to AWS.
+      - This corresponds to the SOPS C(--aws-profile) option.
+    type: str
+    version_added: 1.0.0
+  aws_access_key_id:
+    description:
+      - The AWS access key ID to use for requests to AWS.
+      - Sets the environment variable E(AWS_ACCESS_KEY_ID) for the SOPS call.
+    type: str
+    version_added: 1.0.0
+  aws_secret_access_key:
+    description:
+      - The AWS secret access key to use for requests to AWS.
+      - Sets the environment variable E(AWS_SECRET_ACCESS_KEY) for the SOPS call.
+    type: str
+    version_added: 1.0.0
+  aws_session_token:
+    description:
+      - The AWS session token to use for requests to AWS.
+      - Sets the environment variable E(AWS_SESSION_TOKEN) for the SOPS call.
+    type: str
+    version_added: 1.0.0
+  config_path:
+    description:
+      - Path to the SOPS configuration file.
+      - If not set, SOPS will recursively search for the config file starting at the file that is encrypted or decrypted.
+      - This corresponds to the SOPS C(--config) option.
+    type: path
+    version_added: 1.0.0
+  enable_local_keyservice:
+    description:
+      - Tell SOPS to use local key service.
+      - This corresponds to the SOPS C(--enable-local-keyservice) option.
+    type: bool
+    default: false
+    version_added: 1.0.0
+  keyservice:
+    description:
+      - Specify key services to use next to the local one.
+      - A key service must be specified in the form C(protocol://address), for example C(tcp://myserver.com:5000).
+      - This corresponds to the SOPS C(--keyservice) option.
+    type: list
+    elements: str
+    version_added: 1.0.0
+"""
 
     ANSIBLE_VARIABLES = r'''
 options:

plugins/filter/_latest_version.py

@@ -7,16 +7,15 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 name: _latest_version
 short_description: "[INTERNAL] Get latest version from a list of versions"
 version_added: 1.4.0
 author:
   - Felix Fontein (@felixfontein)
 description:
-  - B(This is an internal tool and must only be used from roles in this collection!)
-    If you use it from outside this collection, be warned that its behavior can change
-    and it can be removed at any time, even in bugfix releases!
+  - B(This is an internal tool and must only be used from roles in this collection!) If you use it from outside this collection,
+    be warned that its behavior can change and it can be removed at any time, even in bugfix releases!
   - Given a list of version numbers, returns the largest of them.
 options:
   _input:
@@ -25,9 +24,9 @@
     type: list
     elements: string
     required: true
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Print latest version
   ansible.builtin.debug:
     msg: "{{ versions | community.sops._latest_version }}"
@@ -36,15 +35,15 @@
       - 1.0.0
       - 1.0.0rc1
       - 1.1.0
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 _value:
-    description:
-      - The latest version from the input.
-      - Returns the empty string if the input was empty.
-    type: string
-'''
+  description:
+    - The latest version from the input.
+    - Returns the empty string if the input was empty.
+  type: string
+"""
 
 from ansible.module_utils.compat.version import LooseVersion