Recursive Submodules
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.
Generating documentation recursively is allowed only with
--output-file
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.
$ 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 .