From 5e487775353906c66060ebee51b1d8e7be3e1886 Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Thu, 30 May 2024 18:36:36 -0400 Subject: [PATCH] Update docs Signed-off-by: Khosrow Moossavi --- cmd/root.go | 2 +- docs/how-to/recursive-submodules.md | 4 +++- docs/reference/asciidoc-document.md | 2 +- docs/reference/asciidoc-table.md | 2 +- docs/reference/asciidoc.md | 2 +- docs/reference/json.md | 2 +- docs/reference/markdown-document.md | 2 +- docs/reference/markdown-table.md | 2 +- docs/reference/markdown.md | 2 +- docs/reference/pretty.md | 2 +- docs/reference/terraform-docs.md | 2 +- docs/reference/tfvars-hcl.md | 2 +- docs/reference/tfvars-json.md | 2 +- docs/reference/tfvars.md | 2 +- docs/reference/toml.md | 2 +- docs/reference/xml.md | 2 +- docs/reference/yaml.md | 2 +- 17 files changed, 19 insertions(+), 17 deletions(-) diff --git a/cmd/root.go b/cmd/root.go index 5ce5403..722e7a2 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -62,7 +62,7 @@ func NewCommand() *cobra.Command { cmd.PersistentFlags().StringVarP(&config.File, "config", "c", ".terraform-docs.yml", "config file name") cmd.PersistentFlags().BoolVar(&config.Recursive.Enabled, "recursive", false, "update submodules recursively (default false)") cmd.PersistentFlags().StringVar(&config.Recursive.Path, "recursive-path", "modules", "submodules path to recursively update") - cmd.PersistentFlags().BoolVar(&config.Recursive.IncludeMain, "recursive-include-main", true, "include the main module (default true)") + cmd.PersistentFlags().BoolVar(&config.Recursive.IncludeMain, "recursive-include-main", true, "include the main module") cmd.PersistentFlags().StringSliceVar(&config.Sections.Show, "show", []string{}, "show section ["+print.AllSections+"]") cmd.PersistentFlags().StringSliceVar(&config.Sections.Hide, "hide", []string{}, "hide section ["+print.AllSections+"]") diff --git a/docs/how-to/recursive-submodules.md b/docs/how-to/recursive-submodules.md index 70400d4..19d45b3 100644 --- a/docs/how-to/recursive-submodules.md +++ b/docs/how-to/recursive-submodules.md @@ -22,7 +22,9 @@ set. Path to find submodules can be configured with `--recursive-path` (defaults to `modules`). -The main module document is generated by default, which can be configured with `--recursive-include-main`. Should the main module document be excluded from document generation, use `--recursive-include-main=false`. +The main module document is generated by default, which can be configured with +`--recursive-include-main`. Should the main module document be excluded from +document generation, use `--recursive-include-main=false`. Each submodule can also have their own `.terraform-docs.yml` config file, to override configuration from root module. diff --git a/docs/reference/asciidoc-document.md b/docs/reference/asciidoc-document.md index 4a975aa..fa78b03 100644 --- a/docs/reference/asciidoc-document.md +++ b/docs/reference/asciidoc-document.md @@ -42,7 +42,7 @@ terraform-docs asciidoc document [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --required show Required column or section (default true) --sensitive show Sensitive column or section (default true) diff --git a/docs/reference/asciidoc-table.md b/docs/reference/asciidoc-table.md index bc88e8a..3898e92 100644 --- a/docs/reference/asciidoc-table.md +++ b/docs/reference/asciidoc-table.md @@ -42,7 +42,7 @@ terraform-docs asciidoc table [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --required show Required column or section (default true) --sensitive show Sensitive column or section (default true) diff --git a/docs/reference/asciidoc.md b/docs/reference/asciidoc.md index e349283..0ed611f 100644 --- a/docs/reference/asciidoc.md +++ b/docs/reference/asciidoc.md @@ -45,7 +45,7 @@ terraform-docs asciidoc [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/json.md b/docs/reference/json.md index c4ad9f1..840dfcd 100644 --- a/docs/reference/json.md +++ b/docs/reference/json.md @@ -39,7 +39,7 @@ terraform-docs json [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/markdown-document.md b/docs/reference/markdown-document.md index a7dffa7..2c18f35 100644 --- a/docs/reference/markdown-document.md +++ b/docs/reference/markdown-document.md @@ -44,7 +44,7 @@ terraform-docs markdown document [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --required show Required column or section (default true) --sensitive show Sensitive column or section (default true) diff --git a/docs/reference/markdown-table.md b/docs/reference/markdown-table.md index bbd82b0..6c6faad 100644 --- a/docs/reference/markdown-table.md +++ b/docs/reference/markdown-table.md @@ -44,7 +44,7 @@ terraform-docs markdown table [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --required show Required column or section (default true) --sensitive show Sensitive column or section (default true) diff --git a/docs/reference/markdown.md b/docs/reference/markdown.md index a7d6089..fb3ecb6 100644 --- a/docs/reference/markdown.md +++ b/docs/reference/markdown.md @@ -47,7 +47,7 @@ terraform-docs markdown [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/pretty.md b/docs/reference/pretty.md index c4d1aa6..401feca 100644 --- a/docs/reference/pretty.md +++ b/docs/reference/pretty.md @@ -39,7 +39,7 @@ terraform-docs pretty [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/terraform-docs.md b/docs/reference/terraform-docs.md index 787c12a..1864b2d 100644 --- a/docs/reference/terraform-docs.md +++ b/docs/reference/terraform-docs.md @@ -33,7 +33,7 @@ terraform-docs [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/tfvars-hcl.md b/docs/reference/tfvars-hcl.md index 4fa083b..cde879a 100644 --- a/docs/reference/tfvars-hcl.md +++ b/docs/reference/tfvars-hcl.md @@ -39,7 +39,7 @@ terraform-docs tfvars hcl [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/tfvars-json.md b/docs/reference/tfvars-json.md index 8537d86..d48e08b 100644 --- a/docs/reference/tfvars-json.md +++ b/docs/reference/tfvars-json.md @@ -38,7 +38,7 @@ terraform-docs tfvars json [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/tfvars.md b/docs/reference/tfvars.md index 717f521..756a483 100644 --- a/docs/reference/tfvars.md +++ b/docs/reference/tfvars.md @@ -34,7 +34,7 @@ Generate terraform.tfvars of inputs. --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/toml.md b/docs/reference/toml.md index d756c1f..f47c173 100644 --- a/docs/reference/toml.md +++ b/docs/reference/toml.md @@ -38,7 +38,7 @@ terraform-docs toml [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/xml.md b/docs/reference/xml.md index 6f39fdd..f898696 100644 --- a/docs/reference/xml.md +++ b/docs/reference/xml.md @@ -38,7 +38,7 @@ terraform-docs xml [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true) diff --git a/docs/reference/yaml.md b/docs/reference/yaml.md index 23e8b50..ff468e6 100644 --- a/docs/reference/yaml.md +++ b/docs/reference/yaml.md @@ -38,7 +38,7 @@ terraform-docs yaml [PATH] [flags] --output-values-from string inject output values from file into outputs (default "") --read-comments use comments as description when description is empty (default true) --recursive update submodules recursively (default false) - --recursive-include-main include the main module (default true) (default true) + --recursive-include-main include the main module (default true) --recursive-path string submodules path to recursively update (default "modules") --show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --sort sort items (default true)