...

Text file src/sigs.k8s.io/gateway-api/hack/api-docs/pkg.tpl

Documentation: sigs.k8s.io/gateway-api/hack/api-docs

     1{{ define "link" }}
     2<li>
     3    <a href="#{{- packageAnchorID . -}}">{{ packageDisplayName . }}</a>
     4</li>
     5{{ end }}
     6
     7{{ define "package" }}
     8<h2 id="{{- packageAnchorID . -}}">
     9    {{- packageDisplayName . -}}
    10</h2>
    11
    12{{ with (index .GoPackages 0 )}}
    13    {{ with .DocComments }}
    14    <p>
    15        {{ safe (renderComments .) }}
    16    </p>
    17    {{ end }}
    18{{ end }}
    19
    20Resource Types:
    21<ul>
    22{{- range (visibleTypes (sortedTypes .Types)) -}}
    23    {{ if isExportedType . -}}
    24    <li>
    25        <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a>
    26    </li>
    27    {{- end }}
    28{{- end -}}
    29</ul>
    30
    31{{ range (visibleTypes (sortedTypes .Types))}}
    32    {{ template "type" .  }}
    33{{ end }}
    34<hr/>
    35{{ end }}
    36
    37
    38{{ define "packages" }}
    39
    40{{/* we manually iterate the packages slice so that we feature beta before alpha */}}
    41
    42<p>Packages:</p>
    43<ul>
    44    {{ template "link" index .packages 1 }}
    45    {{ template "link" index .packages 0 }}
    46</ul>
    47
    48{{ template "package" index .packages 1 }}
    49{{ template "package" index .packages 0 }}
    50
    51<p><em>
    52    Generated with <code>gen-crd-api-reference-docs</code>.
    53</em></p>
    54
    55{{ end }}

View as plain text