-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.terraform-docs.yml
More file actions
85 lines (61 loc) · 1.19 KB
/
.terraform-docs.yml
File metadata and controls
85 lines (61 loc) · 1.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# =============================================================================
# TERRAFORM-DOCS CONFIGURATION
# =============================================================================
#
# Auto-generate documentation for Terraform modules
#
# Documentation: https://terraform-docs.io/
#
# =============================================================================
formatter: markdown table
version: ">= 0.17.0"
header-from: main.tf
footer-from: ""
recursive:
enabled: false
path: modules
sections:
hide: []
show: []
content: |
{{ .Header }}
## Requirements
{{ .Requirements }}
## Providers
{{ .Providers }}
## Modules
{{ .Modules }}
## Resources
{{ .Resources }}
## Inputs
{{ .Inputs }}
## Outputs
{{ .Outputs }}
{{ .Footer }}
output:
file: README.md
mode: inject
template: |-
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
output-values:
enabled: false
from: ""
sort:
enabled: true
by: name
settings:
anchor: true
color: true
default: true
description: true
escape: true
hide-empty: false
html: true
indent: 2
lockfile: true
read-comments: true
required: true
sensitive: true
type: true