.terraform-docs.yml

formatter: template

sections:
  show:
    - header
    - requirements
    - providers
    - data-sources
    - resources
    - modules
    - inputs
    - outputs
    - footer

content: |-
  {{ .Header }}

  _<-- This file is autogenerated, please do not change. -->_

  {{ .Requirements }}

  {{ .Providers }}

  {{ .Resources }}

  {{ .Inputs }}

  {{ .Outputs }}

  ## Examples

  Minimal configuration to install the desired resources with the module

  ```hcl
  {{ include "examples/min_main.tf" }}
  ```

  Advanced configuration to install the desired resources with the module

  ```hcl
  {{ include "examples/full_main.tf" }}
  ```

output:
  mode: replace
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->

sort:
  enabled: true
  by: required

settings:
  anchor: false
  escape: false
  hide-empty: true
  html: true
  indent: 2
  read-comments: true
  required: true
  type: true