From a4a497ca4e91149966efc8974789c17daf7072a2 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 9 Aug 2023 09:46:15 +0200 Subject: [PATCH] remove unnecessary newlines in templates (#537) --- ansibledoctor/doc_parser.py | 4 ++-- ansibledoctor/templates/hugo-book/_requirements.j2 | 1 - ansibledoctor/templates/hugo-book/_vars.j2 | 2 -- ansibledoctor/templates/hugo-book/index.md.j2 | 2 +- ansibledoctor/templates/readme/README.md.j2 | 2 +- ansibledoctor/templates/readme/_requirements.j2 | 1 - ansibledoctor/templates/readme/_vars.j2 | 2 -- example/demo-role/README.md | 5 +---- example/demo-role/meta/main.yml | 6 ++++-- example/other-role/README.md | 5 +++++ example/other-role/meta/main.yml | 6 ++++-- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/ansibledoctor/doc_parser.py b/ansibledoctor/doc_parser.py index 33d813b..dca37d7 100644 --- a/ansibledoctor/doc_parser.py +++ b/ansibledoctor/doc_parser.py @@ -75,6 +75,8 @@ class Parser: ) def _parse_meta_file(self): + self._data["meta"]["name"] = {"value": self.config.config["role_name"]} + for rfile in self._files_registry.get_files(): if any("meta/main." + ext in rfile for ext in YAML_EXTENSIONS): with open(rfile, encoding="utf8") as yaml_file: @@ -91,8 +93,6 @@ class Parser: self._data["meta"]["dependencies"] = { "value": data.get("dependencies") } - - self._data["meta"]["name"] = {"value": self.config.config["role_name"]} except ( ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError ) as e: diff --git a/ansibledoctor/templates/hugo-book/_requirements.j2 b/ansibledoctor/templates/hugo-book/_requirements.j2 index b8d8715..27de08a 100644 --- a/ansibledoctor/templates/hugo-book/_requirements.j2 +++ b/ansibledoctor/templates/hugo-book/_requirements.j2 @@ -1,4 +1,3 @@ - ## Requirements {% if meta | deep_get(meta, "min_ansible_version.value") %} diff --git a/ansibledoctor/templates/hugo-book/_vars.j2 b/ansibledoctor/templates/hugo-book/_vars.j2 index 10044ed..e2c453b 100644 --- a/ansibledoctor/templates/hugo-book/_vars.j2 +++ b/ansibledoctor/templates/hugo-book/_vars.j2 @@ -1,6 +1,5 @@ {% set var = role.var | default({}) %} {% if var %} - ## Default Variables {% for key, item in var | dictsort %} @@ -15,7 +14,6 @@ {% if item.deprecated is defined %} {% set deprecated = [item.deprecated] if item.deprecated is string else item.deprecated %} {% set deprecated_string = deprecated | map("replace", "\n\n", "\n") | safe_join("\n") %} - {% if deprecated_string %} **_Deprecated:_** {{ deprecated_string }}
{% else %} diff --git a/ansibledoctor/templates/hugo-book/index.md.j2 b/ansibledoctor/templates/hugo-book/index.md.j2 index f7894fd..3d1abfc 100644 --- a/ansibledoctor/templates/hugo-book/index.md.j2 +++ b/ansibledoctor/templates/hugo-book/index.md.j2 @@ -17,7 +17,7 @@ summary: {{ meta.summary.value | safe_join(" ") }} {# TOC #} -{% include '_toc.j2' %} +{% include '_toc.j2' +%} {# Requirements #} {% include '_requirements.j2' %} diff --git a/ansibledoctor/templates/readme/README.md.j2 b/ansibledoctor/templates/readme/README.md.j2 index 80c08ec..4d97915 100644 --- a/ansibledoctor/templates/readme/README.md.j2 +++ b/ansibledoctor/templates/readme/README.md.j2 @@ -9,7 +9,7 @@ {% endif %} {# TOC #} -{% include '_toc.j2' %} +{% include '_toc.j2' +%} {# Requirements #} {% include '_requirements.j2' %} diff --git a/ansibledoctor/templates/readme/_requirements.j2 b/ansibledoctor/templates/readme/_requirements.j2 index b8d8715..27de08a 100644 --- a/ansibledoctor/templates/readme/_requirements.j2 +++ b/ansibledoctor/templates/readme/_requirements.j2 @@ -1,4 +1,3 @@ - ## Requirements {% if meta | deep_get(meta, "min_ansible_version.value") %} diff --git a/ansibledoctor/templates/readme/_vars.j2 b/ansibledoctor/templates/readme/_vars.j2 index 10044ed..e2c453b 100644 --- a/ansibledoctor/templates/readme/_vars.j2 +++ b/ansibledoctor/templates/readme/_vars.j2 @@ -1,6 +1,5 @@ {% set var = role.var | default({}) %} {% if var %} - ## Default Variables {% for key, item in var | dictsort %} @@ -15,7 +14,6 @@ {% if item.deprecated is defined %} {% set deprecated = [item.deprecated] if item.deprecated is string else item.deprecated %} {% set deprecated_string = deprecated | map("replace", "\n\n", "\n") | safe_join("\n") %} - {% if deprecated_string %} **_Deprecated:_** {{ deprecated_string }}
{% else %} diff --git a/example/demo-role/README.md b/example/demo-role/README.md index 5503784..7c7ac98 100644 --- a/example/demo-role/README.md +++ b/example/demo-role/README.md @@ -31,14 +31,12 @@ the default description with an annotation. ## Requirements -- Minimum Ansible version: `2.4` - +- Minimum Ansible version: `2.10` ## Default Variables ### demo_role_deprecated - **_Deprecated_**
#### Default value @@ -49,7 +47,6 @@ demo_role_deprecated: b ### demo_role_deprecated_info - **_Deprecated:_** This variable is deprected since `v2.0.0` and will be removed in a future release.
**_Type:_** string
diff --git a/example/demo-role/meta/main.yml b/example/demo-role/meta/main.yml index c42faa6..9916c1d 100644 --- a/example/demo-role/meta/main.yml +++ b/example/demo-role/meta/main.yml @@ -8,14 +8,16 @@ galaxy_info: description: Role to demonstrate ansible-doctor. author: John Doe license: MIT - min_ansible_version: 2.4 + min_ansible_version: "2.10" platforms: - name: EL versions: - - 7 + - "9" galaxy_tags: - demo - documentation + dependencies: - role1 - role: role2 + - name: namespace.role3 diff --git a/example/other-role/README.md b/example/other-role/README.md index e417740..a966bbf 100644 --- a/example/other-role/README.md +++ b/example/other-role/README.md @@ -7,6 +7,7 @@ Role to demonstrate ansible-doctor. ## Table of content +- [Requirements](#requirements) - [Default Variables](#default-variables) - [demo_role_unset](#demo_role_unset) - [Discovered Tags](#discovered-tags) @@ -17,6 +18,10 @@ Role to demonstrate ansible-doctor. --- +## Requirements + +- Minimum Ansible version: `2.10` + ## Default Variables ### demo_role_unset diff --git a/example/other-role/meta/main.yml b/example/other-role/meta/main.yml index be57e83..81e50b0 100644 --- a/example/other-role/meta/main.yml +++ b/example/other-role/meta/main.yml @@ -4,14 +4,16 @@ galaxy_info: description: Role to demonstrate ansible-doctor. author: John Doe license: MIT - min_ansible_version: 2.4 + min_ansible_version: "2.10" platforms: - name: EL versions: - - 7 + - "9" galaxy_tags: - demo - documentation + dependencies: - role1 - role: role2 + - name: namespace.role3