Skip to content

Commit

Permalink
add terraform_docs configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelamattes committed Sep 14, 2023
1 parent dac6fc1 commit 1e1a9de
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .terraform-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
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

0 comments on commit 1e1a9de

Please sign in to comment.