terraform-docs/docs/user-guide/configuration/sections.md at 5cfb2f26159a9373dc47424fa170757857504129

mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 21:08:41 +07:00

Files

Khosrow Moossavi 54dc0f5a7c Add recursive config to .terraform-docs.yml file

Up to now there was only one way to enable recursive execution and that
was with `--recursive` CLI flag. This enables the same behavior but
within config file (i.e. `.terraform-docs.yml`)

Example:

```yaml
recursive:
  enabled: false
  path: modules
```

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>

2021-09-30 15:53:22 -04:00

1.5 KiB

Raw Blame History

title, description, menu, weight, toc

title

description

weight

toc

sections

sections configuration

docs

parent
configuration

128

true

Since v0.10.0

The following options are supported and can be used for sections.show and sections.hide:

all ^{(since v0.15.0)}
data-sources ^{(since v0.13.0)}
header
footer ^{(since v0.12.0)}
inputs
modules ^{(since v0.11.0)}
outputs
providers
requirements
resources ^{(since v0.11.0)}

{{< alert type="warning" >}} The following options cannot be used together:

sections.hide and sections.show
sections.hide-all and sections.show-all
sections.hide-all and sections.hide
sections.show-all and sections.show {{< /alert >}}

{{< alert type="info" >}} As of v0.13.0, sections.hide-all and sections.show-all are deprecated in favor of explicit use of sections.hide and sections.show, and they are removed as of v0.15.0. {{< /alert >}}

Options

Available options with their default values.

sections:
  hide: []
  show: []

  hide-all: false # deprecated in v0.13.0, removed in v0.15.0
  show-all: true  # deprecated in v0.13.0, removed in v0.15.0

Examples

Show only providers, inputs, and outputs.

sections:
  show:
    - providers
    - inputs
    - outputs

Show everything except providers.

sections:
  hide:
    - providers

1.5 KiB Raw Blame History

Options

Examples

1.5 KiB

Raw Blame History