From 3df7e465dbd66965693c663fb12c282827d08ebb Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sun, 2 Jun 2024 00:08:33 +0200 Subject: [PATCH] docs: add documentation for tabulated vars option (#705) --- docs/content/usage/configuration.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/content/usage/configuration.md b/docs/content/usage/configuration.md index e9562be..2e76a79 100644 --- a/docs/content/usage/configuration.md +++ b/docs/content/usage/configuration.md @@ -44,6 +44,10 @@ template: readme # with spaces does not work. If you want to use spaces to indent text, you must disable # this option. template_autotrim: True +# Configures whether to tabulate variables in the output. When set to `True`, +# variables will be displayed in a tabular format intsead of plain marktdown sections. +# NOTE: This option does not support rendering multiline code blocks. +tabulate_variables: False # Don't ask to overwrite if output file exists. force_overwrite: False @@ -103,6 +107,7 @@ ANSIBLE_DOCTOR_OUTPUT_DIR= ANSIBLE_DOCTOR_TEMPLATE_DIR= ANSIBLE_DOCTOR_TEMPLATE=readme ANSIBLE_DOCTOR_TEMPLATE_AUTOTRIM=true +ANSIBLE_DOCTOR_TABULATE_VARIABLES=false ANSIBLE_DOCTOR_FORCE_OVERWRITE=false ANSIBLE_DOCTOR_CUSTOM_HEADER= ANSIBLE_DOCTOR_EXCLUDE_FILES=