{#def obj: dict | None = None, name: str = "", level: int = 2, members: bool = True, #} {% set obj = obj or autodoc(name) %} {{ obj.symbol }} {{ name or obj.name }} {% if obj.label -%} {{ obj.label }} {%- endif %} {%- if obj.short_description -%}
{{ obj.short_description | markdown | utils.widont }}
{% endif -%} {%- if obj.signature -%}
{% filter markdown -%} ```python {{ obj.signature }} ``` {%- endfilter %}
{%- endif %} {% if obj.bases -%}

Bases: {%- for base in obj.bases %} {{ base }}{% if not loop.last %}, {% endif %} {%- endfor %}

{%- endif %} {% if obj.params -%} {%- for param in obj.params %} {%- endfor %}
ArgumentDescription
{{ param.name }} {{ param.description | markdown | utils.widont }}
{%- endif %} {%- if obj.description -%}
{{ obj.description | markdown | utils.widont }}
{% endif -%} {% if obj.examples -%}

Example:

{% for ex in obj.examples -%}
{% if ex.description %}{{ ex.description | markdown | utils.widont }}{% endif %} {% if ex.snippet %}{{ ex.snippet }}{% endif %}
{% endfor -%}
{%- endif %} {% if obj.returns -%}
  • Returns:

    {% if ex.returns -%}

    {{ obj.returns }}

    {%- endif %} {% if ex.many_returns -%}
      {% for return in ex.many_returns %}
    • {{ return }}
    • {%- endfor %}
    {%- endif %}
  • {%- endif %} {% if obj.raises -%}

    Raises: