github.com/olli-ai/jx/v2@v2.0.400-0.20210921045218-14731b4dd448/docs/refdocs/templates/pkg.tpl (about)

     1  {{ define "packages" }}
     2  
     3  {{ with .packages}}
     4  ---
     5  title: API Documentation
     6  linktitle: API Documentation
     7  description: Reference of the Jenkins X REST APIs and custom resources
     8  weight: 10
     9  ---
    10  
    11  <p>Packages:</p>
    12  <ul>
    13      {{ range . }}
    14      <li>
    15          <a href="#{{- packageAnchorID . -}}">{{ packageDisplayName . }}</a>
    16      </li>
    17      {{ end }}
    18  </ul>
    19  {{ end}}
    20  
    21  {{ range .packages }}
    22      <h2 id="{{- packageAnchorID . -}}">
    23          {{- packageDisplayName . -}}
    24      </h2>
    25  
    26      {{ with (index .GoPackages 0 )}}
    27          {{ with .DocComments }}
    28          <p>
    29              {{ safe (renderComments .) }}
    30          </p>
    31          {{ end }}
    32      {{ end }}
    33  
    34      Resource Types:
    35      <ul>
    36      {{- range (visibleTypes (sortedTypes .Types)) -}}
    37          {{ if isExportedType . -}}
    38          <li>
    39              <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a>
    40          </li>
    41          {{- end }}
    42      {{- end -}}
    43      </ul>
    44  
    45      {{ range (visibleTypes (sortedTypes .Types))}}
    46          {{ template "type" .  }}
    47      {{ end }}
    48      <hr/>
    49  {{ end }}
    50  
    51  <p><em>
    52      Generated with <code>gen-crd-api-reference-docs</code>
    53      {{ with .gitCommit }} on git commit <code>{{ . }}</code>{{end}}.
    54  </em></p>
    55  
    56  {{ end }}