Update website content

from: terraform-docs/terraform-docs@d64ab6e

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.
 

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

content/user-guide/configuration.md

@@ -79,6 +79,7 @@ footer-from: ""
 recursive:
   enabled: false
   path: modules
+  include-main: true
 
 sections:
   hide: []

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
+```