{#- Template for "Receives" sections in docstrings. This template renders a list of documented received values (generators) in the format specified with the [`docstring_section_style`][] configuration option. Context: section (griffe.DocstringSectionAttributes): The section to render. -#} {% block logs scoped %} {#- Logging block. This block can be used to log debug messages, deprecation messages, warnings, etc. -#} {{ log.debug("Rendering receives section") }} {% endblock logs %} {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #} {% import "language"|get_template as lang with context %} {#- Language module providing the `t` translation method. -#} {% if config.docstring_section_style == "table" %} {% block table_style scoped %} {#- Block for the `table` section style. -#} {% set name_column = section.value|selectattr("name")|any %}
{{ section.title or lang.t("Receives:") }}
| {{ lang.t("Name") }} | {% endif %}{{ lang.t("Type") }} | {{ lang.t("Description") }} |
|---|---|---|
{% if receives.name %}{{ receives.name }}{% endif %} | {% endif %}
{% if receives.annotation %}
{% with expression = receives.annotation, backlink_type = "received-by" %}
{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
{% include "expression"|get_template with context %}
{% endwith %}
{% endif %}
|
{{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
{{ section.title or lang.t("Receives:") }}
{{ receives.name }}{% endif %}
{% if receives.annotation %}
{% with expression = receives.annotation, backlink_type = "received-by" %}
{% if receives.name %} ({% endif %}
{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
{% include "expression"|get_template with context %}
{% if receives.name %}){% endif %}
{% endwith %}
{% endif %}
–
| {{ (section.title or lang.t("RECEIVES")).rstrip(":").upper() }} | {{ lang.t("DESCRIPTION") }} |
|---|---|
{% if receives.name %}
{{ receives.name }}
{% elif receives.annotation %}
{% with expression = receives.annotation, backlink_type = "received-by" %}
{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
{% include "expression"|get_template with context %}
{% endwith %}
{% endif %}
|
{{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
{% if receives.name and receives.annotation %}
{{ lang.t("TYPE:") }}
{% with expression = receives.annotation, backlink_type = "received-by" %}
{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
|