From 80a1b8e33acc204eef1e183bee05c2a9b19a06cc Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Tue, 8 Oct 2019 13:43:41 +0200 Subject: [PATCH] add example --- ansibledoctor/templates/readme/README.md.j2 | 3 +++ ansibledoctor/templates/readme/_toc.j2 | 14 ++++++++++++ ansibledoctor/templates/readme/_vars.j2 | 4 ---- example/README.md | 25 +++++++++++++-------- 4 files changed, 33 insertions(+), 13 deletions(-) create mode 100644 ansibledoctor/templates/readme/_toc.j2 diff --git a/ansibledoctor/templates/readme/README.md.j2 b/ansibledoctor/templates/readme/README.md.j2 index be23304..1f11e1a 100644 --- a/ansibledoctor/templates/readme/README.md.j2 +++ b/ansibledoctor/templates/readme/README.md.j2 @@ -5,6 +5,9 @@ {{ description | deep_get(meta, "description.value") }} {% endif %} +{# TOC #} +{% include '_toc.j2' %} + {# Vars #} {% include '_vars.j2' %} diff --git a/ansibledoctor/templates/readme/_toc.j2 b/ansibledoctor/templates/readme/_toc.j2 new file mode 100644 index 0000000..b33aefe --- /dev/null +++ b/ansibledoctor/templates/readme/_toc.j2 @@ -0,0 +1,14 @@ +## Table of content + +{% set var = role.var | default({}) %} +{% if var %} +* [Default Variables](#default-variables) +{% for key, item in var.items() %} + * [{{ key }}](#{{ key }}) +{% endfor %} +{% endif %} +* [Dependencies](#dependencies) +* [License](#license) +* [Author](#author) + +--- diff --git a/ansibledoctor/templates/readme/_vars.j2 b/ansibledoctor/templates/readme/_vars.j2 index caba131..9a32766 100644 --- a/ansibledoctor/templates/readme/_vars.j2 +++ b/ansibledoctor/templates/readme/_vars.j2 @@ -2,10 +2,6 @@ {% if var %} ## Default Variables {% for key, item in var.items() %} -* [{{ key }}](#{{ key }}) -{% endfor %} ---- -{% for key, item in var.items() %} ### {{ key }} {% if item.description is defined and item.description %} diff --git a/example/README.md b/example/README.md index bff2223..27fd1f2 100644 --- a/example/README.md +++ b/example/README.md @@ -2,16 +2,23 @@ Role to demonstrate ansible-doctor -## Default Variables -* [demo_role_unset](#demo_role_unset) -* [demo_role_empty](#demo_role_empty) -* [demo_role_single](#demo_role_single) -* [demo_role_empty_dict](#demo_role_empty_dict) -* [demo_role_dict](#demo_role_dict) -* [demo_role_other_tags](#demo_role_other_tags) -* [dockerengine_packages_extra](#dockerengine_packages_extra) -* [demo_role_undefined_var](#demo_role_undefined_var) +## Table of content + +* [Default Variables](#default-variables) + * [demo_role_unset](#demo_role_unset) + * [demo_role_empty](#demo_role_empty) + * [demo_role_single](#demo_role_single) + * [demo_role_empty_dict](#demo_role_empty_dict) + * [demo_role_dict](#demo_role_dict) + * [demo_role_other_tags](#demo_role_other_tags) + * [dockerengine_packages_extra](#dockerengine_packages_extra) + * [demo_role_undefined_var](#demo_role_undefined_var) +* [Dependencies](#dependencies) +* [License](#license) +* [Author](#author) + --- +## Default Variables ### demo_role_unset