Examples in Google style do not show about griffe HOT 5 CLOSED

Done! Will release it soon.

from griffe.

I solved this issue by changing {% if section_type == "markdown" %} to {% if section_type|string == "DocstringSectionKind.text" %}, and also changing {% if section_type == "examples" %} to {% if section_type|string == "DocstringSectionKind.examples" %}.

Now it looks like:

So for the developer: I think the corresponding code in the template of examples need to be modified in such way. Could you please confirm this?

How I got the solution:
After I found {{ section_type == "DocstringSectionKind.examples"}} is still False, I think although the type of section_type is indeed DocstringSectionKind.examples, but it is not equal to a string "DocstringSectionKind.examples". So I managed to change section_type to a string type. I tried str(section_type) but got an error when running mkdocs, from which I got to know that the language (?) is called "jinja2", so I searched "jinja2 how to convert variable to string", and found the answer is section_type|string. Finally I came up with the solution.

from griffe.

Hi again @wxdrizzle! Thanks for the detailed bug report, and the solution to the issue 😄
Indeed, I forgot to update this template: we now use enums and can't compare them directly to strings.
And markdown was changed to text.

So the final fix will look like this:

{% for section_type, sub_section in section.value %}
  {% if section_type.value == "text" %}
    {{ sub_section|convert_markdown(heading_level, html_id) }}
  {% elif section_type.value == "examples" %}
    {{ sub_section|highlight(language="python", linenums=False) }}
  {% endif %}
{% endfor %}

Do you want to send a PR (on the mkdocstrings/python repo) with that 🙂? If not, I'll do it in the afternoon anyway!

from griffe.

Great work! Sorry that I just woke up due to the time difference. Thank you for the quick reply and quick fix @pawamoy 😄

from griffe.

Sorry that I just woke up due to the time difference

Haha no problem of course 😄

from griffe.