Update anstibull-docs (#284)

ansible · Aug 27, 2024 · be8c3d1 · be8c3d1
1 parent a2401af
commit be8c3d1
Show file tree

Hide file tree

Showing 17 changed files with 125 additions and 178 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,4 @@ docs/build.sh
 docs/antsibull-docs.cfg
 docs/conf.py
 tests/integration/inventory
+docs/temp-rst
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -2,7 +2,6 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-# Created with antsibull-docs 2.12.0
+# Created with antsibull-docs 2.13.0
 
-/temp-rst
 /build
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-# Created with antsibull-docs 2.12.0
+# Created with antsibull-docs 2.13.0
 
 antsibull-docs >= 2.0.0, < 3.0.0
 ansible-pygments

diff --git a/docs/rst/activation_info_module.rst b/docs/rst/activation_info_module.rst
@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.12.0
+  :antsibull-docs: 2.13.0
 
 .. Anchors
 
@@ -111,7 +110,7 @@ Parameters
 
       The URL of the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_URL`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_URL` environment variable will be used.
 
 
       .. raw:: html
@@ -150,7 +149,7 @@ Parameters
 
       Password used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_PASSWORD` environment variable will be used.
 
 
       .. raw:: html
@@ -189,7 +188,7 @@ Parameters
 
       Username used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_USERNAME` environment variable will be used.
 
 
       .. raw:: html
@@ -262,7 +261,7 @@ Parameters
 
       Timeout in seconds for the connection with the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_TIMEOUT` environment variable will be used.
 
 
       .. rst-class:: ansible-option-line
@@ -305,11 +304,11 @@ Parameters
 
       Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
 
-      If \ :literal:`no`\ , SSL certificates will not be validated.
+      If :literal:`no`\ , SSL certificates will not be validated.
 
       This should only be used on personally controlled sites using self-signed certificates.
 
-      If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\ 
+      If value not set, will try environment variable :literal:`CONTROLLER\_VERIFY\_SSL`
 
 
       .. rst-class:: ansible-option-line
@@ -341,14 +340,12 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
-      - name: Get information about a rulebook activation
-        ansible.eda.activation_info:
-          name: "Example Rulebook Activation"
-
-      - name: List all rulebook activations
-        ansible.eda.activation_info:
+    - name: Get information about a rulebook activation
+      ansible.eda.activation_info:
+        name: "Example Rulebook Activation"
 
+    - name: List all rulebook activations
+      ansible.eda.activation_info:
 
 
 
@@ -449,4 +446,3 @@ Collection links
 
 
 .. Parsing errors
-
diff --git a/docs/rst/activation_module.rst b/docs/rst/activation_module.rst
@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.12.0
+  :antsibull-docs: 2.13.0
 
 .. Anchors
 
@@ -148,7 +147,7 @@ Parameters
 
       The URL of the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_URL`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_URL` environment variable will be used.
 
 
       .. raw:: html
@@ -187,7 +186,7 @@ Parameters
 
       Password used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_PASSWORD` environment variable will be used.
 
 
       .. raw:: html
@@ -226,7 +225,7 @@ Parameters
 
       Username used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_USERNAME` environment variable will be used.
 
 
       .. raw:: html
@@ -672,7 +671,7 @@ Parameters
 
       Timeout in seconds for the connection with the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_TIMEOUT` environment variable will be used.
 
 
       .. rst-class:: ansible-option-line
@@ -880,11 +879,11 @@ Parameters
 
       Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
 
-      If \ :literal:`no`\ , SSL certificates will not be validated.
+      If :literal:`no`\ , SSL certificates will not be validated.
 
       This should only be used on personally controlled sites using self-signed certificates.
 
-      If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\ 
+      If value not set, will try environment variable :literal:`CONTROLLER\_VERIFY\_SSL`
 
 
       .. rst-class:: ansible-option-line
@@ -955,7 +954,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
     - name: Create a rulebook activation
       ansible.eda.activation:
         name: "Example Rulebook Activation"
@@ -973,7 +971,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -1072,4 +1069,3 @@ Collection links
 
 
 .. Parsing errors
-
diff --git a/docs/rst/controller_token_module.rst b/docs/rst/controller_token_module.rst
@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.12.0
+  :antsibull-docs: 2.13.0
 
 .. Anchors
 
@@ -111,7 +110,7 @@ Parameters
 
       The URL of the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_URL`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_URL` environment variable will be used.
 
 
       .. raw:: html
@@ -150,7 +149,7 @@ Parameters
 
       Password used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_PASSWORD` environment variable will be used.
 
 
       .. raw:: html
@@ -189,7 +188,7 @@ Parameters
 
       Username used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_USERNAME` environment variable will be used.
 
 
       .. raw:: html
@@ -225,7 +224,7 @@ Parameters
 
       The description of the project.
 
-      Required when \ :ansopt:`ansible.eda.controller\_token#module:state=present`\ .
+      Required when :ansopt:`ansible.eda.controller\_token#module:state=present`.
 
 
       .. raw:: html
@@ -298,7 +297,7 @@ Parameters
 
       Timeout in seconds for the connection with the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_TIMEOUT` environment variable will be used.
 
 
       .. rst-class:: ansible-option-line
@@ -380,7 +379,7 @@ Parameters
 
       The AWX token value.
 
-      Required when \ :ansopt:`ansible.eda.controller\_token#module:state=present`\ .
+      Required when :ansopt:`ansible.eda.controller\_token#module:state=present`.
 
 
       .. raw:: html
@@ -419,11 +418,11 @@ Parameters
 
       Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
 
-      If \ :literal:`no`\ , SSL certificates will not be validated.
+      If :literal:`no`\ , SSL certificates will not be validated.
 
       This should only be used on personally controlled sites using self-signed certificates.
 
-      If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\ 
+      If value not set, will try environment variable :literal:`CONTROLLER\_VERIFY\_SSL`
 
 
       .. rst-class:: ansible-option-line
@@ -460,7 +459,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
     - name: Create AWX token
       ansible.eda.controller_token:
         controller_host: https://my_eda_host/
@@ -482,7 +480,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -580,4 +577,3 @@ Collection links
 
 
 .. Parsing errors
-
diff --git a/docs/rst/credential_info_module.rst b/docs/rst/credential_info_module.rst
@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.12.0
+  :antsibull-docs: 2.13.0
 
 .. Anchors
 
@@ -111,7 +110,7 @@ Parameters
 
       The URL of the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_URL`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_URL` environment variable will be used.
 
 
       .. raw:: html
@@ -150,7 +149,7 @@ Parameters
 
       Password used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_PASSWORD` environment variable will be used.
 
 
       .. raw:: html
@@ -189,7 +188,7 @@ Parameters
 
       Username used for authentication.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_USERNAME` environment variable will be used.
 
 
       .. raw:: html
@@ -262,7 +261,7 @@ Parameters
 
       Timeout in seconds for the connection with the EDA controller.
 
-      If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\  environment variable will be used.
+      If not set, the value of the :literal:`CONTROLLER\_TIMEOUT` environment variable will be used.
 
 
       .. rst-class:: ansible-option-line
@@ -305,11 +304,11 @@ Parameters
 
       Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
 
-      If \ :literal:`no`\ , SSL certificates will not be validated.
+      If :literal:`no`\ , SSL certificates will not be validated.
 
       This should only be used on personally controlled sites using self-signed certificates.
 
-      If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\ 
+      If value not set, will try environment variable :literal:`CONTROLLER\_VERIFY\_SSL`
 
 
       .. rst-class:: ansible-option-line
@@ -341,14 +340,12 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
-      - name: Get information about a credential
-        ansible.eda.credential_info:
-          name: "Test"
-
-      - name: List all credentials
-        ansible.eda.credential_info:
+    - name: Get information about a credential
+      ansible.eda.credential_info:
+        name: "Test"
 
+    - name: List all credentials
+      ansible.eda.credential_info:
 
 
 
@@ -449,4 +446,3 @@ Collection links
 
 
 .. Parsing errors
-