centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

Run make docs

Browse Source 
Signed-off-by: Blake Gong <blakegong@gmail.com>
This commit is contained in:
Blake Gong
2022-07-27 10:26:13 +08:00
committed by Khosrow Moossavi
parent 59eb90fc86
commit e4af9978f4
15 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/asciidoc-document.md
View File

@@ -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) (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)

1
docs/reference/asciidoc-table.md
View File

@@ -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) (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)

1
docs/reference/asciidoc.md
View File

@@ -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) (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)

1
docs/reference/json.md
View File

@@ -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) (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)

1
docs/reference/markdown-document.md
View File

@@ -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) (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)

1
docs/reference/markdown-table.md
View File

@@ -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) (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)

1
docs/reference/markdown.md
View File

@@ -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) (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)

1
docs/reference/pretty.md
View File

@@ -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) (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)

1
docs/reference/terraform-docs.md
View File

@@ -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) (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)

1
docs/reference/tfvars-hcl.md
View File

@@ -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) (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)

1
docs/reference/tfvars-json.md
View File

@@ -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) (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)

1
docs/reference/tfvars.md
View File

@@ -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) (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)

1
docs/reference/toml.md
View File

@@ -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) (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)

1
docs/reference/xml.md
View File

@@ -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) (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)

1
docs/reference/yaml.md
View File

@@ -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) (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)