forked from rook/rook
add generate-crd-docs.sh tool for auto-generate the documentation for CRDs automatically Closes: #1873 Signed-off-by: Javier <sjavierlopez@gmail.com>
49 lines
1.1 KiB
Smarty
49 lines
1.1 KiB
Smarty
{{ define "members" }}
|
|
|
|
{{ range .Members }}
|
|
{{ if not (hiddenMember .)}}
|
|
<tr>
|
|
<td>
|
|
<code>{{ fieldName . }}</code><br/>
|
|
<em>
|
|
{{ if linkForType .Type }}
|
|
<a href="{{ linkForType .Type}}">
|
|
{{ typeDisplayName .Type }}
|
|
</a>
|
|
{{ else }}
|
|
{{ typeDisplayName .Type }}
|
|
{{ end }}
|
|
</em>
|
|
</td>
|
|
<td>
|
|
{{ if fieldEmbedded . }}
|
|
<p>
|
|
(Members of <code>{{ fieldName . }}</code> are embedded into this type.)
|
|
</p>
|
|
{{ end}}
|
|
|
|
{{ if isOptionalMember .}}
|
|
<em>(Optional)</em>
|
|
{{ end }}
|
|
|
|
{{ safe (renderComments .CommentLines) }}
|
|
|
|
{{ if and (eq (.Type.Name.Name) "ObjectMeta") }}
|
|
Refer to the Kubernetes API documentation for the fields of the
|
|
<code>metadata</code> field.
|
|
{{ end }}
|
|
|
|
{{ if or (eq (fieldName .) "spec") }}
|
|
<br/>
|
|
<br/>
|
|
<table>
|
|
{{ template "members" .Type }}
|
|
</table>
|
|
{{ end }}
|
|
</td>
|
|
</tr>
|
|
{{ end }}
|
|
{{ end }}
|
|
|
|
{{ end }}
|