From be8c3d1ae1bf428f0e9913195b7ce948306efee3 Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Tue, 27 Aug 2024 11:41:02 +0100 Subject: [PATCH] Update anstibull-docs (#284) --- .gitignore | 1 + docs/.gitignore | 3 +- docs/requirements.txt | 2 +- docs/rst/activation_info_module.rst | 28 +++++----- docs/rst/activation_module.rst | 18 +++---- docs/rst/controller_token_module.rst | 22 ++++---- docs/rst/credential_info_module.rst | 28 +++++----- docs/rst/credential_module.rst | 18 +++---- docs/rst/credential_type_info_module.rst | 28 +++++----- docs/rst/credential_type_module.rst | 52 +++++++++---------- docs/rst/decision_environment_info_module.rst | 18 +++---- docs/rst/decision_environment_module.rst | 18 +++---- docs/rst/environment_variables.rst | 3 +- docs/rst/index.rst | 6 +-- docs/rst/project_info_module.rst | 18 +++---- docs/rst/project_module.rst | 18 +++---- docs/rst/user_module.rst | 22 ++++---- 17 files changed, 125 insertions(+), 178 deletions(-) diff --git a/.gitignore b/.gitignore index d1f65bb1..a4279856 100644 --- 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 index b143a48a..082ce669 100644 --- 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 index 7bf076c5..117a86cf 100644 --- 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 index 95f4908e..cac1f844 100644 --- 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 index b8b668fd..b1e01ba7 100644 --- 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 index 394b13a3..55d2b7ec 100644 --- 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 index 30d2b111..ba97a1fa 100644 --- 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 - diff --git a/docs/rst/credential_module.rst b/docs/rst/credential_module.rst index 7648dd28..1274686a 100644 --- a/docs/rst/credential_module.rst +++ b/docs/rst/credential_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 @@ -436,7 +435,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 @@ -521,11 +520,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 @@ -557,7 +556,6 @@ Examples .. code-block:: yaml+jinja - - name: Create an EDA Credential ansible.eda.credential: name: "Example Credential" @@ -574,7 +572,6 @@ Examples - .. Facts @@ -673,4 +670,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/credential_type_info_module.rst b/docs/rst/credential_type_info_module.rst index c2690d43..d746f3d7 100644 --- a/docs/rst/credential_type_info_module.rst +++ b/docs/rst/credential_type_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 type - ansible.eda.credential_type_info: - name: "Test" - - - name: List all credential types - ansible.eda.credential_type_info: + - name: Get information about a credential type + ansible.eda.credential_type_info: + name: "Test" + - name: List all credential types + ansible.eda.credential_type_info: @@ -449,4 +446,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/credential_type_module.rst b/docs/rst/credential_type_module.rst index e2b799f6..225d79d1 100644 --- a/docs/rst/credential_type_module.rst +++ b/docs/rst/credential_type_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 @@ -398,7 +397,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 @@ -483,11 +482,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 @@ -519,26 +518,24 @@ Examples .. code-block:: yaml+jinja - - - name: Create a credential type - ansible.eda.credential_type: - name: "Test" - state: present - description: "A test credential type" - inputs: - fields: - - id: "Field1" - type: "string" - label: "Label1" - injectors: - extra_vars: - field1: "field1" - - - name: Delete a credential type - ansible.eda.credential_type: - name: "Test" - state: absent + - name: Create a credential type + ansible.eda.credential_type: + name: "Test" + state: present + description: "A test credential type" + inputs: + fields: + - id: "Field1" + type: "string" + label: "Label1" + injectors: + extra_vars: + field1: "field1" + - name: Delete a credential type + ansible.eda.credential_type: + name: "Test" + state: absent @@ -639,4 +636,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/decision_environment_info_module.rst b/docs/rst/decision_environment_info_module.rst index 18cc4522..3160b7f6 100644 --- a/docs/rst/decision_environment_info_module.rst +++ b/docs/rst/decision_environment_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,7 +340,6 @@ Examples .. code-block:: yaml+jinja - - name: List all EDA Decision Environments ansible.eda.decision_environment_info: controller_host: https://my_eda_host/ @@ -357,7 +355,6 @@ Examples - .. Facts @@ -455,4 +452,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/decision_environment_module.rst b/docs/rst/decision_environment_module.rst index 4ab8ea81..b0b6a1c9 100644 --- a/docs/rst/decision_environment_module.rst +++ b/docs/rst/decision_environment_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 @@ -436,7 +435,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 @@ -521,11 +520,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 @@ -557,7 +556,6 @@ Examples .. code-block:: yaml+jinja - - name: Create EDA Decision Environment ansible.eda.decision_environment: controller_host: https://my_eda_host/ @@ -590,7 +588,6 @@ Examples - .. Facts @@ -689,4 +686,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/environment_variables.rst b/docs/rst/environment_variables.rst index 3007982b..90ed821e 100644 --- a/docs/rst/environment_variables.rst +++ b/docs/rst/environment_variables.rst @@ -1,8 +1,7 @@ - :orphan: .. meta:: - :antsibull-docs: 2.12.0 + :antsibull-docs: 2.13.0 .. _list_of_collection_env_vars: diff --git a/docs/rst/index.rst b/docs/rst/index.rst index 8d6a13d6..56919763 100644 --- a/docs/rst/index.rst +++ b/docs/rst/index.rst @@ -1,7 +1,5 @@ - - .. meta:: - :antsibull-docs: 2.12.0 + :antsibull-docs: 2.13.0 .. _plugins_in_ansible.eda: @@ -85,5 +83,3 @@ Modules project_module project_info_module user_module - - diff --git a/docs/rst/project_info_module.rst b/docs/rst/project_info_module.rst index f8fe8d3e..8ee86672 100644 --- a/docs/rst/project_info_module.rst +++ b/docs/rst/project_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 @@ -264,7 +263,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 @@ -307,11 +306,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 @@ -343,7 +342,6 @@ Examples .. code-block:: yaml+jinja - - name: List a particular project ansible.eda.project_info: controller_host: https://my_eda_host/ @@ -361,7 +359,6 @@ Examples - .. Facts @@ -459,4 +456,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/project_module.rst b/docs/rst/project_module.rst index 9d264a3c..fd8eb3ae 100644 --- a/docs/rst/project_module.rst +++ b/docs/rst/project_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 @@ -402,7 +401,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 @@ -521,11 +520,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 @@ -557,7 +556,6 @@ Examples .. code-block:: yaml+jinja - - name: Create EDA Projects ansible.eda.project: controller_host: https://my_eda_host/ @@ -591,7 +589,6 @@ Examples - .. Facts @@ -630,4 +627,3 @@ Collection links .. Parsing errors - diff --git a/docs/rst/user_module.rst b/docs/rst/user_module.rst index b8ec7ccb..ec4c22ab 100644 --- a/docs/rst/user_module.rst +++ b/docs/rst/user_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 @@ -440,7 +439,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 @@ -520,9 +519,9 @@ Parameters
- \ :ansval:`true`\ will always change password if user specifies password, even if API gives $encrypted$ for password. + :ansval:`true` will always change password if user specifies password, even if API gives $encrypted$ for password. - \ :ansval:`false`\ will only set the password if other values change too. + :ansval:`false` will only set the password if other values change too. .. rst-class:: ansible-option-line @@ -607,11 +606,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 @@ -643,7 +642,6 @@ Examples .. code-block:: yaml+jinja - - name: Create EDA user ansible.eda.user: controller_host: https://my_eda_host/ @@ -677,7 +675,6 @@ Examples - .. Facts @@ -776,4 +773,3 @@ Collection links .. Parsing errors -