physical-ai-toolchain/.terraform-docs.yml at main · microsoft/physical-ai-toolchain · GitHub

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
formatter: "markdown table"

version: ">= 0.19.0, < 1.0.0"

header-from: main.tf

content: |-
  {{- $header := .Header | default "# Terraform IaC" -}}
  {{- $paragraphs := splitList "\n\n" $header -}}
  {{- $title := first $paragraphs | trimPrefix "# " -}}
  {{- $desc := "Auto-generated Terraform reference documentation" -}}
  {{- if gt (len $paragraphs) 1 -}}
  {{- $desc = index $paragraphs 1 | replace "\n" " " -}}
  {{- end -}}
  ---
  title: {{ $title }}
  description: {{ $desc | quote }}
  author: Microsoft Robotics-AI Team
  ms.date: {{ now | date "2006-01-02" }}
  ms.topic: reference
  ---

  <!-- BEGIN_TF_DOCS -->
  {{- $body := $header | trimPrefix (first $paragraphs) | trimPrefix "\n\n" -}}
  {{- if ne $body "" }}
  {{ $body }}
  {{- end }}
  {{- with .Requirements }}{{ println }}
  {{ . }}
  {{- end }}
  {{- with .Providers }}{{ println }}
  {{ . }}
  {{- end }}
  {{- with .Resources }}{{ println }}
  {{ . }}
  {{- end }}
  {{- with .Modules }}{{ println }}
  {{ . }}
  {{- end }}
  {{- with .Inputs }}{{ println }}
  {{ . }}
  {{- end }}
  {{- with .Outputs }}{{ println }}
  {{ . }}
  {{- end }}
  <!-- END_TF_DOCS -->

  <!-- markdownlint-disable MD036 -->
  *🤖 Auto-generated by [terraform-docs](https://terraform-docs.io/) — do not edit manually.*
  <!-- markdownlint-enable MD036 -->

output:
  file: TERRAFORM.md
  mode: replace
  template: |
    {{ .Content }}

sort:
  enabled: true
  by: required

settings:
  anchor: false
  escape: true
  hide-empty: true
  html: false
  lockfile: false
  required: true
  sensitive: true
  type: true