Reformat documentation with 'andebox yaml-doc' (#828)

* Reformat documentation with 'andebox yaml-doc'.

* Fix/improve.

* Remaining fixes.

* One more.

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'''
@@ -45,12 +45,12 @@ class ModuleDocFragment(object):
         - acme
 '''
 
-    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'''
@@ -68,18 +68,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/ecs_credential.py

@@ -11,34 +11,34 @@
 class ModuleDocFragment(object):
 
     # Plugin options for Entrust Certificate Services (ECS) credentials
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    entrust_api_user:
-        description:
-            - The username for authentication to the Entrust Certificate Services (ECS) API.
-        type: str
-        required: true
-    entrust_api_key:
-        description:
-            - The key (password) for authentication to the Entrust Certificate Services (ECS) API.
-        type: str
-        required: true
-    entrust_api_client_cert_path:
-        description:
-            - The path to the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.
-        type: path
-        required: true
-    entrust_api_client_cert_key_path:
-        description:
-            - The path to the key for the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.
-        type: path
-        required: true
-    entrust_api_specification_path:
-        description:
-            - The path to the specification file defining the Entrust Certificate Services (ECS) API configuration.
-            - You can use this to keep a local copy of the specification to avoid downloading it every time the module is used.
-        type: path
-        default: https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml
+  entrust_api_user:
+    description:
+      - The username for authentication to the Entrust Certificate Services (ECS) API.
+    type: str
+    required: true
+  entrust_api_key:
+    description:
+      - The key (password) for authentication to the Entrust Certificate Services (ECS) API.
+    type: str
+    required: true
+  entrust_api_client_cert_path:
+    description:
+      - The path to the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.
+    type: path
+    required: true
+  entrust_api_client_cert_key_path:
+    description:
+      - The path to the key for the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.
+    type: path
+    required: true
+  entrust_api_specification_path:
+    description:
+      - The path to the specification file defining the Entrust Certificate Services (ECS) API configuration.
+      - You can use this to keep a local copy of the specification to avoid downloading it every time the module is used.
+    type: path
+    default: https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml
 requirements:
-    - "PyYAML >= 3.11"
-'''
+  - "PyYAML >= 3.11"
+"""

plugins/doc_fragments/module_certificate.py

@@ -12,80 +12,79 @@
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 description:
-    - This module allows one to (re)generate OpenSSL certificates.
-    - It uses the cryptography python library to interact with OpenSSL.
+  - This module allows one to (re)generate OpenSSL certificates.
+  - It uses the cryptography python library to interact with OpenSSL.
 requirements:
-    - cryptography >= 1.6 (if using V(selfsigned) or V(ownca) provider)
+  - cryptography >= 1.6 (if using V(selfsigned) or V(ownca) provider)
 options:
-    force:
-        description:
-            - Generate the certificate, even if it already exists.
-        type: bool
-        default: false
-
-    csr_path:
-        description:
-            - Path to the Certificate Signing Request (CSR) used to generate this certificate.
-            - This is mutually exclusive with O(csr_content).
-        type: path
-    csr_content:
-        description:
-            - Content of the Certificate Signing Request (CSR) used to generate this certificate.
-            - This is mutually exclusive with O(csr_path).
-        type: str
-
-    privatekey_path:
-        description:
-            - Path to the private key to use when signing the certificate.
-            - This is mutually exclusive with O(privatekey_content).
-        type: path
-    privatekey_content:
-        description:
-            - Content of the private key to use when signing the certificate.
-            - This is mutually exclusive with O(privatekey_path).
-        type: str
-
-    privatekey_passphrase:
-        description:
-            - The passphrase for the O(privatekey_path) resp. O(privatekey_content).
-            - This is required if the private key is password protected.
-        type: str
-
-    ignore_timestamps:
-        description:
-            - Whether the "not before" and "not after" timestamps should be ignored for idempotency checks.
-            - It is better to keep the default value V(true) when using relative timestamps (like V(+0s) for now).
-        type: bool
-        default: true
-        version_added: 2.0.0
-
-    select_crypto_backend:
-        description:
-            - Determines which crypto backend to use.
-            - The default choice is V(auto), which tries to use C(cryptography) if available.
-            - If set to V(cryptography), will try to use the L(cryptography,https://cryptography.io/) library.
-        type: str
-        default: auto
-        choices: [ auto, cryptography ]
+  force:
+    description:
+      - Generate the certificate, even if it already exists.
+    type: bool
+    default: false
+
+  csr_path:
+    description:
+      - Path to the Certificate Signing Request (CSR) used to generate this certificate.
+      - This is mutually exclusive with O(csr_content).
+    type: path
+  csr_content:
+    description:
+      - Content of the Certificate Signing Request (CSR) used to generate this certificate.
+      - This is mutually exclusive with O(csr_path).
+    type: str
+
+  privatekey_path:
+    description:
+      - Path to the private key to use when signing the certificate.
+      - This is mutually exclusive with O(privatekey_content).
+    type: path
+  privatekey_content:
+    description:
+      - Content of the private key to use when signing the certificate.
+      - This is mutually exclusive with O(privatekey_path).
+    type: str
+
+  privatekey_passphrase:
+    description:
+      - The passphrase for the O(privatekey_path) resp. O(privatekey_content).
+      - This is required if the private key is password protected.
+    type: str
+
+  ignore_timestamps:
+    description:
+      - Whether the "not before" and "not after" timestamps should be ignored for idempotency checks.
+      - It is better to keep the default value V(true) when using relative timestamps (like V(+0s) for now).
+    type: bool
+    default: true
+    version_added: 2.0.0
+
+  select_crypto_backend:
+    description:
+      - Determines which crypto backend to use.
+      - The default choice is V(auto), which tries to use C(cryptography) if available.
+      - If set to V(cryptography), will try to use the L(cryptography,https://cryptography.io/) library.
+    type: str
+    default: auto
+    choices: [auto, cryptography]
 
 notes:
-    - All ASN.1 TIME values should be specified following the YYYYMMDDHHMMSSZ pattern.
-    - Date specified should be UTC. Minutes and seconds are mandatory.
-    - For security reason, when you use V(ownca) provider, you should NOT run
-      M(community.crypto.x509_certificate) on a target machine, but on a dedicated CA machine. It
-      is recommended not to store the CA private key on the target machine. Once signed, the
-      certificate can be moved to the target machine.
+  - All ASN.1 TIME values should be specified following the YYYYMMDDHHMMSSZ pattern.
+  - Date specified should be UTC. Minutes and seconds are mandatory.
+  - For security reason, when you use V(ownca) provider, you should NOT run M(community.crypto.x509_certificate) on a target
+    machine, but on a dedicated CA machine. It is recommended not to store the CA private key on the target machine. Once
+    signed, the certificate can be moved to the target machine.
 seealso:
-- module: community.crypto.openssl_csr
-- module: community.crypto.openssl_csr_pipe
-- module: community.crypto.openssl_dhparam
-- module: community.crypto.openssl_pkcs12
-- module: community.crypto.openssl_privatekey
-- module: community.crypto.openssl_privatekey_pipe
-- module: community.crypto.openssl_publickey
-'''
+  - module: community.crypto.openssl_csr
+  - module: community.crypto.openssl_csr_pipe
+  - module: community.crypto.openssl_dhparam
+  - module: community.crypto.openssl_pkcs12
+  - module: community.crypto.openssl_privatekey
+  - module: community.crypto.openssl_privatekey_pipe
+  - module: community.crypto.openssl_publickey
+"""
 
     BACKEND_ACME_DOCUMENTATION = r'''
 description: