From fb86c09b5626b6e2c24e2ef2b687399c000268e2 Mon Sep 17 00:00:00 2001 From: terraform-docs-bot Date: Thu, 30 May 2024 22:45:55 +0000 Subject: [PATCH] Update website content from: https://github.com/terraform-docs/terraform-docs/commit/d64ab6edbbd54be2517a68b012c11b2b8a6037f6 --- content/how-to/recursive-submodules.md | 4 ++++ content/reference/asciidoc-document.md | 1 + content/reference/asciidoc-table.md | 1 + content/reference/asciidoc.md | 1 + content/reference/json.md | 1 + content/reference/markdown-document.md | 1 + content/reference/markdown-table.md | 1 + content/reference/markdown.md | 1 + content/reference/pretty.md | 1 + content/reference/terraform-docs.md | 1 + content/reference/tfvars-hcl.md | 1 + content/reference/tfvars-json.md | 1 + content/reference/tfvars.md | 1 + content/reference/toml.md | 1 + content/reference/xml.md | 1 + content/reference/yaml.md | 1 + content/user-guide/configuration.md | 1 + content/user-guide/configuration/recursive.md | 10 ++++++++++ 18 files changed, 30 insertions(+) diff --git a/content/how-to/recursive-submodules.md b/content/how-to/recursive-submodules.md index 0751b51..19d45b3 100644 --- a/content/how-to/recursive-submodules.md +++ b/content/how-to/recursive-submodules.md @@ -22,6 +22,10 @@ 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`. + Each submodule can also have their own `.terraform-docs.yml` config file, to override configuration from root module. diff --git a/content/reference/asciidoc-document.md b/content/reference/asciidoc-document.md index 0d26d6d..fa78b03 100644 --- a/content/reference/asciidoc-document.md +++ b/content/reference/asciidoc-document.md @@ -42,6 +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) --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/content/reference/asciidoc-table.md b/content/reference/asciidoc-table.md index b343f96..3898e92 100644 --- a/content/reference/asciidoc-table.md +++ b/content/reference/asciidoc-table.md @@ -42,6 +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) --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/content/reference/asciidoc.md b/content/reference/asciidoc.md index 783a327..0ed611f 100644 --- a/content/reference/asciidoc.md +++ b/content/reference/asciidoc.md @@ -45,6 +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) --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/content/reference/json.md b/content/reference/json.md index fe4583e..840dfcd 100644 --- a/content/reference/json.md +++ b/content/reference/json.md @@ -39,6 +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) --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/content/reference/markdown-document.md b/content/reference/markdown-document.md index b614611..2c18f35 100644 --- a/content/reference/markdown-document.md +++ b/content/reference/markdown-document.md @@ -44,6 +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) --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/content/reference/markdown-table.md b/content/reference/markdown-table.md index f3775a8..6c6faad 100644 --- a/content/reference/markdown-table.md +++ b/content/reference/markdown-table.md @@ -44,6 +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) --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/content/reference/markdown.md b/content/reference/markdown.md index ab947d2..fb3ecb6 100644 --- a/content/reference/markdown.md +++ b/content/reference/markdown.md @@ -47,6 +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) --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/content/reference/pretty.md b/content/reference/pretty.md index d3e798d..401feca 100644 --- a/content/reference/pretty.md +++ b/content/reference/pretty.md @@ -39,6 +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) --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/content/reference/terraform-docs.md b/content/reference/terraform-docs.md index ccc71e5..1864b2d 100644 --- a/content/reference/terraform-docs.md +++ b/content/reference/terraform-docs.md @@ -33,6 +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) --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/content/reference/tfvars-hcl.md b/content/reference/tfvars-hcl.md index 7abc874..cde879a 100644 --- a/content/reference/tfvars-hcl.md +++ b/content/reference/tfvars-hcl.md @@ -39,6 +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) --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/content/reference/tfvars-json.md b/content/reference/tfvars-json.md index 0354b35..d48e08b 100644 --- a/content/reference/tfvars-json.md +++ b/content/reference/tfvars-json.md @@ -38,6 +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) --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/content/reference/tfvars.md b/content/reference/tfvars.md index 38834dc..756a483 100644 --- a/content/reference/tfvars.md +++ b/content/reference/tfvars.md @@ -34,6 +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) --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/content/reference/toml.md b/content/reference/toml.md index a0c649d..f47c173 100644 --- a/content/reference/toml.md +++ b/content/reference/toml.md @@ -38,6 +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) --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/content/reference/xml.md b/content/reference/xml.md index 633f124..f898696 100644 --- a/content/reference/xml.md +++ b/content/reference/xml.md @@ -38,6 +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) --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/content/reference/yaml.md b/content/reference/yaml.md index 577de59..ff468e6 100644 --- a/content/reference/yaml.md +++ b/content/reference/yaml.md @@ -38,6 +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) --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/content/user-guide/configuration.md b/content/user-guide/configuration.md index 9f0b06c..51528b6 100644 --- a/content/user-guide/configuration.md +++ b/content/user-guide/configuration.md @@ -79,6 +79,7 @@ footer-from: "" recursive: enabled: false path: modules + include-main: true sections: hide: [] diff --git a/content/user-guide/configuration/recursive.md b/content/user-guide/configuration/recursive.md index 1ccf4c8..ab1a251 100644 --- a/content/user-guide/configuration/recursive.md +++ b/content/user-guide/configuration/recursive.md @@ -32,6 +32,7 @@ Available options with their default values. recursive: enabled: false path: modules + include-main: true ``` ## Examples @@ -50,3 +51,12 @@ recursive: enabled: true path: submodules-folder ``` + +Skip the main module document, and only generate documents for submodules. + +```yaml +recursive: + enabled: true + path: submodules-folder + include-main: false +```