-
Notifications
You must be signed in to change notification settings - Fork 10
/
.terraform-docs-internal.yml
131 lines (100 loc) · 2.63 KB
/
.terraform-docs-internal.yml
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
formatter: "markdown document" # this is required
version: ""
header-from: ".header.md"
output:
file: .README.md
mode: replace
template: |-
{{ .Content }}
sort:
enabled: false
settings:
indent: 3
lockfile: false
escape: false
content: |-
{{ .Header }}
## Reference
{{ if ne (len .Module.Requirements) 0 -}}
### Requirements
{{ range .Module.Requirements }}
- `{{ .Name }}`{{ if .Version }}, version: {{ .Version }}{{ end }}
{{- end }}
{{- end }}
{{ if ne (len .Module.Providers) 0 -}}
### Providers
{{ range .Module.Providers }}
- `{{ .Name }}`{{ if .Version }}, version: {{ .Version }}{{ end }}
{{- end }}
{{- end }}
{{ if ne (len .Module.ModuleCalls) 0 -}}
### Modules
Name | Version | Source | Description
--- | --- | --- | ---
{{- range .Module.ModuleCalls }}
`{{ .Name }}` | {{ if .Version }}{{ .Version }}{{ else }}-{{ end }} | {{ .Source }} | {{ .Description }}
{{- end }}
{{- end }}
{{ if ne (len .Module.Resources) 0 -}}
### Resources
{{ range .Module.Resources }}
- `{{ .Type }}` ({{ .Mode }})
{{- end }}
{{- end }}
### Required Inputs
Name | Type | Description
--- | --- | ---
{{- range .Module.Inputs }}
{{- if .Required }}
[`{{ .Name }}`](#{{ .Name }}) | `{{ (split "(" .Type.Raw)._0 }}` | {{ (split "." .Description.Raw)._0 }}.
{{- end }}
{{- end }}
{{ $optional := false -}}
{{ range .Module.Inputs }}{{ if not .Required }}{{ $optional = true -}}{{ end -}}{{ end -}}
{{ if $optional -}}
### Optional Inputs
Name | Type | Description
--- | --- | ---
{{- range .Module.Inputs }}
{{- if not .Required }}
[`{{ .Name }}`](#{{ .Name }}) | `{{ (split "(" .Type.Raw)._0 }}` | {{ (split "." .Description.Raw)._0 }}.
{{- end -}}
{{ end -}}
{{ end }}
{{ if ne (len .Module.Outputs) 0 -}}
### Outputs
Name | Description
--- | ---
{{- range .Module.Outputs }}
`{{ .Name }}` | {{ .Description.Raw }}
{{- end }}
{{- end }}
### Required Inputs details
{{ range .Module.Inputs -}}
{{ if .Required -}}
#### {{ .Name }}
{{ .Description }}
Type: {{ if lt (len (split "\n" .Type.Raw)) 2 }}{{ .Type }}{{ else }}
```hcl
{{ .Type }}
```
{{ end }}
<sup>[back to list](#modules-required-inputs)</sup>
{{ end -}}
{{- end -}}
{{ if $optional -}}
### Optional Inputs details
{{ range .Module.Inputs -}}
{{ if not .Required -}}
#### {{ .Name }}
{{ .Description }}
Type: {{ if lt (len (split "\n" .Type.Raw)) 2 }}{{ .Type }}{{ else }}
```hcl
{{ .Type }}
```
{{ end }}
Default value: `{{ .Default }}`
<sup>[back to list](#modules-optional-inputs)</sup>
{{ end }}
{{- end -}}
{{ end -}}