mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
8f74fd4453
Prepend any type of resource, including `resource`, `data`, `module`, `variable`, and `output` with a comment including "terraform-docs-ignore" to exclude it from the generated output. Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
1.7 KiB
1.7 KiB
title, description, menu, weight, toc
| title | description | menu | weight | toc | ||||
|---|---|---|---|---|---|---|---|---|
| Recursive Submodules | How to generate submodules documentation recursively with terraform-docs |
|
207 | false |
Since v0.15.0
Considering the file structure below of main module and its submodules, it is
possible to generate documentation for the main and all its submodules in one
execution, with --recursive flag.
{{< alert type="warning" >}}
Generating documentation recursively is allowed only with --output-file
set.
{{< /alert >}}
Path to find submodules can be configured with --recursive-path (defaults to
modules).
Each submodule can also have their own .terraform-docs.yml config file, to
override configuration from root module.
$ pwd
/path/to/module
$ tree .
.
├── README.md
├── main.tf
├── modules
│ └── my-sub-module
│ ├── README.md
│ ├── main.tf
│ ├── variables.tf
│ └── versions.tf
├── outputs.tf
├── variables.tf
└── versions.tf
$ terraform-docs markdown --recursive --output-file README.md .
Alternatively recursive.enabled config also can be used instead of CLI flag.
$ pwd
/path/to/module
$ tree .
.
├── README.md
├── main.tf
├── modules
│ └── my-sub-module
│ ├── README.md
│ ├── main.tf
│ ├── variables.tf
│ └── versions.tf
├── outputs.tf
├── variables.tf
├── versions.tf
├── ...
└── .terraform-docs.yml
$ cat .terraform-docs.yml
formatter: markdown table
recursive:
enabled: true
output:
file: README.md
mode: inject
$ terraform-docs .