Skip to content

[bot] Merge master/c4a6afe1 into rel/dev #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yenkins-admin merged 2 commits into from
Feb 12, 2025
Merged

[bot] Merge master/c4a6afe1 into rel/dev #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7b161c
docs: fix malformed api-ref
hkad98 Feb 12, 2025
c4a6afe
Merge pull request #984 from hkad98/jkd/docs
hkad98 Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/layouts/partials/api-ref-function-parenthesis.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{{ $funcObj := . }}
{{/* Create the parenthesis string for signature. Example "(text: str, number: int) */}}
{{ $parenthesisArgsString := "" }}
{{ if $funcObj.docstring_parsed }}
{{ range $funcObj.docstring_parsed.params}}
{{ $parenthesisArgsString = print $parenthesisArgsString .arg_name ": " .type_name ", " }}
{{ end }}
{{ end }}
{{ $parenthesisArgsString := strings.TrimRight ", " $parenthesisArgsString }}
{{trim $parenthesisArgsString " "}}
{{- $funcObj := . -}}
{{- /* Create the parenthesis string for signature */ -}}
{{- $parenthesisArgsString := "" -}}
{{- if $funcObj.docstring_parsed -}}
{{- range $funcObj.docstring_parsed.params -}}
{{- $parenthesisArgsString = print $parenthesisArgsString .arg_name ": " .type_name ", " -}}
{{- end -}}
{{- end -}}
{{- $parenthesisArgsString := strings.TrimRight ", " $parenthesisArgsString -}}
{{- $parenthesisArgsString -}}
147 changes: 76 additions & 71 deletions docs/layouts/partials/api-ref-object-partial.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@

{{ $parenthesisArgsString := partial "api-ref-function-parenthesis.html" $objData}}
{{ if not $objData.is_property }}
<p><code>
{{ (index (last 1 $path) 0) }}({{- $parenthesisArgsString -}}) -> {{ partial "api-ref-link-partial.html" (dict "paragraph" $objData.signature.return_annotation "context" $context) }}
</code></p>
<p><code>{{ (index (last 1 $path) 0) }}({{- $parenthesisArgsString -}}) -> {{ partial "api-ref-link-partial.html" (dict
"paragraph" $objData.signature.return_annotation "context" $context) }}</code></p>
{{ else }}
<p><code>
{{ (index (last 1 $path) 0) }} -> {{ partial "api-ref-link-partial.html" (dict "paragraph" $objData.signature.return_annotation "context" $context) }}
</code></p>
<p><code>{{ (index (last 1 $path) 0) }} -> {{ partial "api-ref-link-partial.html" (dict "paragraph"
$objData.signature.return_annotation "context" $context) }}</code></p>
{{ end }}

{{ if $objData.docstring_parsed}}
<div class="python-ref-description">
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description | safeHTML) "context" $context) }}</p>
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description | safeHTML) "context" $context)}}</p>
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description |
safeHTML) "context" $context) }}</p>
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description |
safeHTML) "context" $context)}}</p>
</div>
{{ end }}

Expand All @@ -29,51 +29,53 @@ <h4> Parameters </h4>
{{ if $objData.docstring_parsed }}
{{ if (index $objData.docstring_parsed "params") }}
{{ if (gt (len $objData.docstring_parsed.params) 0) }}
<table class="gd-docs-parameters-block">
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
{{range $objData.docstring_parsed.params}}
<tr>
<td> {{ .arg_name }} </td>
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" .type_name "context" $context) }} </td>
<td> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" (.description | safeHTML) "context" $context) }} </td>
</tr>
{{end}}
</tbody>
</table>
<table class="gd-docs-parameters-block">
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
{{range $objData.docstring_parsed.params}}
<tr>
<td> {{ .arg_name }}</td>
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" .type_name "context" $context) }}</td>
<td> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" (.description | safeHTML) "context" $context)
}}
</td>
</tr>
{{end}}
</tbody>
</table>
{{ else }}
<i> None </i>
<i> None </i>
{{ end }}
{{ else if (ne $objData.signature.return_type "None") }}
<table class="gd-docs-parameters-block">
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
{{range $objData.signature.params}}
<tr>
<td> {{ index . 0 }} </td>
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" (index . 1) "context" $context) }} </td>
<td> <i> None </i> </td>
</tr>
{{end}}
</tbody>
</table>
<table class="gd-docs-parameters-block">
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
{{range $objData.signature.params}}
<tr>
<td> {{ index . 0 }}</td>
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" (index . 1) "context" $context) }}</td>
<td><i> None </i></td>
</tr>
{{end}}
</tbody>
</table>
{{ else }}
<i> None </i>
<i> None </i>
{{ end }}
{{ else }}
<i> None </i>
<i> None </i>
{{ end }}
{{ end }}

Expand All @@ -84,34 +86,35 @@ <h4> Returns </h4>
{{ else if or $objData.docstring_parsed.returns.type_name (ne $objData.signature.return_annotation "None") }}
{{ $typeName := "" }}
{{ if $objData.docstring_parsed.returns.type_name }}
{{ $typeName = $objData.docstring_parsed.returns.type_name }}
{{ $typeName = $objData.docstring_parsed.returns.type_name }}
{{ else }}
{{ $typeName = $objData.signature.return_type }}
{{ $typeName = $objData.signature.return_type }}
{{ end }}

{{ $description := $objData.docstring_parsed.returns.description }}

<table class="gd-docs-parameters-block">
<thead>
<tr>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
{{ partial "api-ref-link-partial.html" (dict "paragraph" $typeName "context" $context) }}
</td>
<td>
{{ if $description }}
{{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.returns.description | safeHTML) "context" $context) }}
{{ else }}
<i> None </i>
{{ end }}
</td>
</tr>
</tbody>
<thead>
<tr>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
{{ partial "api-ref-link-partial.html" (dict "paragraph" $typeName "context" $context) }}
</td>
<td>
{{ if $description }}
{{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.returns.description
| safeHTML) "context" $context) }}
{{ else }}
<i> None </i>
{{ end }}
</td>
</tr>
</tbody>
</table>
{{ else }}
<i> None </i>
Expand All @@ -124,8 +127,10 @@ <h4> Returns </h4>
<h1> {{index (last 2 $path) 0}}.{{ index (last 1 $path) 0 }} </h1>
{{ if $objData.docstring_parsed }}
<div class="python-ref-description">
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description | safeHTML) "context" $context) }}</p>
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description | safeHTML) "context" $context) }}</p>
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description |
safeHTML) "context" $context) }}</p>
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description |
safeHTML) "context" $context) }}</p>
</div>
{{ end }}
{{end}}
Expand Down
Loading