From 0f384508681c294c29eb4bcaef87ef70059f7df4 Mon Sep 17 00:00:00 2001 From: Vladimir Botka Date: Sun, 30 Jan 2022 01:30:53 +0100 Subject: [PATCH] Fixed indentation. Comments and notes added. --- .../helper/lists_mergeby/default-common.yml | 1 + .../docsite/helper/lists_mergeby/list3.out.j2 | 2 +- .../docsite/helper/lists_mergeby/playbook.yml | 16 +- ...rmations_merging_lists_of_dictionaries.rst | 229 +++++++++--------- 4 files changed, 130 insertions(+), 118 deletions(-) diff --git a/docs/docsite/helper/lists_mergeby/default-common.yml b/docs/docsite/helper/lists_mergeby/default-common.yml index ff6a31df6e..69227fbe44 100644 --- a/docs/docsite/helper/lists_mergeby/default-common.yml +++ b/docs/docsite/helper/lists_mergeby/default-common.yml @@ -5,6 +5,7 @@ list1: extra: false - name: meh extra: true + list2: - name: foo path: /foo diff --git a/docs/docsite/helper/lists_mergeby/list3.out.j2 b/docs/docsite/helper/lists_mergeby/list3.out.j2 index f2f1e6c8e7..764ce3bd1d 100644 --- a/docs/docsite/helper/lists_mergeby/list3.out.j2 +++ b/docs/docsite/helper/lists_mergeby/list3.out.j2 @@ -1,2 +1,2 @@ list3: - {{ list3|to_nice_yaml|indent(2) }} +{{ list3|to_nice_yaml(indent=0) }} diff --git a/docs/docsite/helper/lists_mergeby/playbook.yml b/docs/docsite/helper/lists_mergeby/playbook.yml index 6fc2a71cc0..ae82932275 100644 --- a/docs/docsite/helper/lists_mergeby/playbook.yml +++ b/docs/docsite/helper/lists_mergeby/playbook.yml @@ -1,15 +1,25 @@ --- + # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # 1) Run all examples and create example-XXX.out # shell> ansible-playbook playbook.yml -e examples=true # -# 2) Optionally, create examples_all.rst +# 2) Optionally, for testing, create examples_all.rst # shell> ansible-playbook playbook.yml -e examples_all=true # -# 3) Create other REST files. See the blocks below. +# 3) Create docs REST files # shell> ansible-playbook playbook.yml -e merging_lists_of_dictionaries=true +# +# Notes: +# * Use YAML callback, e.g. set ANSIBLE_STDOUT_CALLBACK=community.general.yaml +# * Use sphinx-view to render and review the REST files +# shell> sphinx-view /examples_all.rst +# * Proofread and copy completed docs *.rst files into the directory rst. +# * Then delete the *.rst and *.out files from this directory. Do not +# add *.rst and *.out in this directory to the version control. +# # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# docs/docsite/helper/lists_mergeby/playbook.yml +# community.general/docs/docsite/helper/lists_mergeby/playbook.yml - hosts: localhost gather_facts: false diff --git a/docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst b/docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst index 026454155d..38b14241b9 100644 --- a/docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst +++ b/docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst @@ -16,6 +16,7 @@ Let us use the lists below in the following examples extra: false - name: meh extra: true + list2: - name: foo path: /foo @@ -34,15 +35,15 @@ This produces: .. code-block:: yaml list3: - - extra: false - name: bar - - name: baz - path: /baz - - extra: true - name: foo - path: /foo - - extra: true - name: meh + - extra: false + name: bar + - name: baz + path: /baz + - extra: true + name: foo + path: /foo + - extra: true + name: meh .. versionadded:: 2.0.0 @@ -59,15 +60,15 @@ This produces the same result as in the previous example: .. code-block:: yaml list3: - - extra: false - name: bar - - name: baz - path: /baz - - extra: true - name: foo - path: /foo - - extra: true - name: meh + - extra: false + name: bar + - name: baz + path: /baz + - extra: true + name: foo + path: /foo + - extra: true + name: meh The filter also accepts two optional parameters: ``recursive`` and ``list_merge``. These parameters are only supported when used with ansible-base 2.10 or ansible-core, but not with Ansible 2.9. This is available since community.general 4.4.0. @@ -117,19 +118,19 @@ This produces: .. code-block:: yaml list3: - - name: myname01 - param01: - list: - - patch_value - x: default_value - y: patch_value - z: patch_value - - name: myname02 - param01: - - 3 - - 4 - - 4 - - key: value + - name: myname01 + param01: + list: + - patch_value + x: default_value + y: patch_value + z: patch_value + - name: myname02 + param01: + - 3 + - 4 + - 4 + - key: value Example ``list_merge=keep``: @@ -145,19 +146,19 @@ This produces: .. code-block:: yaml list3: - - name: myname01 - param01: - list: - - default_value - x: default_value - y: patch_value - z: patch_value - - name: myname02 - param01: - - 1 - - 1 - - 2 - - 3 + - name: myname01 + param01: + list: + - default_value + x: default_value + y: patch_value + z: patch_value + - name: myname02 + param01: + - 1 + - 1 + - 2 + - 3 Example ``list_merge=append``: @@ -173,24 +174,24 @@ This produces: .. code-block:: yaml list3: - - name: myname01 - param01: - list: - - default_value - - patch_value - x: default_value - y: patch_value - z: patch_value - - name: myname02 - param01: - - 1 - - 1 - - 2 - - 3 - - 3 - - 4 - - 4 - - key: value + - name: myname01 + param01: + list: + - default_value + - patch_value + x: default_value + y: patch_value + z: patch_value + - name: myname02 + param01: + - 1 + - 1 + - 2 + - 3 + - 3 + - 4 + - 4 + - key: value Example ``list_merge=prepend``: @@ -206,24 +207,24 @@ This produces: .. code-block:: yaml list3: - - name: myname01 - param01: - list: - - patch_value - - default_value - x: default_value - y: patch_value - z: patch_value - - name: myname02 - param01: - - 3 - - 4 - - 4 - - key: value - - 1 - - 1 - - 2 - - 3 + - name: myname01 + param01: + list: + - patch_value + - default_value + x: default_value + y: patch_value + z: patch_value + - name: myname02 + param01: + - 3 + - 4 + - 4 + - key: value + - 1 + - 1 + - 2 + - 3 Example ``list_merge=append_rp``: @@ -239,23 +240,23 @@ This produces: .. code-block:: yaml list3: - - name: myname01 - param01: - list: - - default_value - - patch_value - x: default_value - y: patch_value - z: patch_value - - name: myname02 - param01: - - 1 - - 1 - - 2 - - 3 - - 4 - - 4 - - key: value + - name: myname01 + param01: + list: + - default_value + - patch_value + x: default_value + y: patch_value + z: patch_value + - name: myname02 + param01: + - 1 + - 1 + - 2 + - 3 + - 4 + - 4 + - key: value Example ``list_merge=prepend_rp``: @@ -271,21 +272,21 @@ This produces: .. code-block:: yaml list3: - - name: myname01 - param01: - list: - - patch_value - - default_value - x: default_value - y: patch_value - z: patch_value - - name: myname02 - param01: - - 3 - - 4 - - 4 - - key: value - - 1 - - 1 - - 2 + - name: myname01 + param01: + list: + - patch_value + - default_value + x: default_value + y: patch_value + z: patch_value + - name: myname02 + param01: + - 3 + - 4 + - 4 + - key: value + - 1 + - 1 + - 2