Skip to content

Commit 6184e3a

Browse files
DEVOPS-270 updated terraform-docs conf file
1 parent ec46619 commit 6184e3a

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

.terraform-docs.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
formatter: "markdown table" # this is required
2+
version: "0.18"
3+
header-from: main.tf
4+
footer-from: ""
5+
recursive:
6+
enabled: true
7+
path: "."
8+
# - "api-management"
9+
recursive-include-main: false
10+
# enabled: false
11+
sections:
12+
hide: []
13+
show: []
14+
hide-all: false # deprecated in v0.13.0, removed in v0.15.0
15+
show-all: true # deprecated in v0.13.0, removed in v0.15.0
16+
content: |-
17+
{{ .Requirements }}
18+
## Usage
19+
Basic usage of this module is as follows:
20+
```hcl
21+
module "example" {
22+
{{"\t"}} source = "<module-path>"
23+
{{- if .Module.RequiredInputs }}
24+
{{"\n\t"}} # Required variables
25+
{{- range .Module.RequiredInputs }}
26+
{{"\t"}} {{ .Name }} = {{ .GetValue }}
27+
{{- end }}
28+
{{- end }}
29+
{{- if .Module.OptionalInputs }}
30+
{{"\n\t"}} # Optional variables
31+
{{- range .Module.OptionalInputs }}
32+
{{"\t"}} {{ .Name }} = {{ .GetValue | printf "%s" }}
33+
{{- end }}
34+
{{- end }}
35+
}
36+
````
37+
38+
{{ .Resources }}
39+
40+
{{ .Inputs }}
41+
42+
{{ .Outputs }}
43+
output:
44+
file: README.md
45+
mode: inject
46+
template: |-
47+
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
48+
{{ .Content }}
49+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->
50+
output-values:
51+
enabled: false
52+
from: ""
53+
sort:
54+
enabled: true
55+
by: name
56+
settings:
57+
anchor: true
58+
color: true
59+
default: false
60+
description: true
61+
escape: false
62+
hide-empty: false
63+
html: false
64+
indent: 2
65+
lockfile: true
66+
read-comments: true
67+
required: true
68+
sensitive: true
69+
type: true
70+
pretty: true

0 commit comments

Comments
 (0)