sigs.k8s.io/kueue@v0.6.2/site/genref/markdown/pkg.tpl (about)

     1  {{ define "packages" -}}
     2  
     3  {{- range $idx, $val := .packages -}}
     4  {{/* Special handling for config */}}
     5    {{- if .IsMain -}}
     6  ---
     7  title: {{ .Title }}
     8  content_type: tool-reference
     9  package: {{ .DisplayName }}
    10  auto_generated: true
    11  description: Generated API reference documentation for {{ if ne .GroupName "" -}} {{ .DisplayName }}{{ else -}} Kueue Configuration{{- end -}}.
    12  ---
    13  {{ .GetComment -}}
    14    {{- end -}}
    15  {{- end }}
    16  
    17  ## Resource Types 
    18  
    19  {{ range .packages -}}
    20    {{ $isConfig := (eq .GroupName "") }}
    21    {{- range .VisibleTypes -}}
    22      {{- if or .IsExported (and $isConfig (eq .DisplayName "Configuration")) }}
    23  - [{{ .DisplayName }}]({{ .Link }})
    24      {{- end -}}
    25    {{- end -}}
    26  {{- end -}}
    27  
    28  {{ range .packages }}
    29    {{ if ne .GroupName "" -}}
    30      {{/* For package with a group name, list all type definitions in it. */}}
    31      {{- range .VisibleTypes }}
    32        {{- if or .Referenced .IsExported -}}
    33  {{ template "type" . }}
    34        {{- end -}}
    35      {{ end }}
    36    {{ else }}
    37      {{/* For package w/o group name, list only types referenced. */}}
    38      {{ $isConfig := (eq .GroupName "") }}
    39      {{- range .VisibleTypes -}}
    40        {{- if or .Referenced $isConfig -}}
    41  {{ template "type" . }}
    42        {{- end -}}
    43      {{- end }}
    44    {{- end }}
    45  {{- end }}
    46  {{- end }}