vino/hack/api-docs/template/pkg.tpl
Sean Eagan 0e2baf38e4 Generate api docs for CRD types
Change-Id: I803689985c0010b452f52bfe9a57bc5e910d051f
Signed-off-by: Sean Eagan <seaneagan1@gmail.com>
2021-02-02 13:37:28 -06:00

47 lines
1.2 KiB
Smarty

{{ define "packages" }}
<h1>Vino API reference</h1>
{{ with .packages}}
<p>Packages:</p>
<ul class="simple">
{{ range . }}
<li>
<a href="#{{- packageAnchorID . -}}">{{ packageDisplayName . }}</a>
</li>
{{ end }}
</ul>
{{ end}}
{{ range .packages }}
<h2 id="{{- packageAnchorID . -}}">
{{- packageDisplayName . -}}
</h2>
{{ with (index .GoPackages 0 )}}
{{ with .DocComments }}
{{ safe (renderComments .) }}
{{ end }}
{{ end }}
Resource Types:
<ul class="simple">
{{- range (visibleTypes (sortedTypes .Types)) -}}
{{ if isExportedType . -}}
<li>
<a href="{{ linkForType . }}">{{ typeDisplayName . }}</a>
</li>
{{- end }}
{{- end -}}
</ul>
{{ range (visibleTypes (sortedTypes .Types))}}
{{ template "type" . }}
{{ end }}
{{ end }}
<div class="admonition note">
<p class="last">This page was automatically generated with <code>gen-crd-api-reference-docs</code></p>
</div>
{{ end }}