fix: Fix examples rendering

pawamoy · pawamoy · commit a06a7e34c701 · 2022-02-20T16:03:11.000+01:00
Issue mkdocstrings/griffe#46: mkdocstrings/griffe#46
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html
@@ -1,9 +1,9 @@
 {{ log.debug("Rendering examples section") }}
 <p><strong>{{ section.title or "Examples:" }}</strong></p>
 {% for section_type, sub_section in section.value %}
-  {% if section_type == "markdown" %}
+  {% if section_type.value == "text" %}
     {{ sub_section|convert_markdown(heading_level, html_id) }}
-  {% elif section_type == "examples" %}
+  {% elif section_type.value == "examples" %}
     {{ sub_section|highlight(language="python", linenums=False) }}
   {% endif %}
 {% endfor %}
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -84,3 +84,18 @@ def fixture_ext_markdown(plugin):
         A Markdown instance.
     """
     return plugin.md
+
+
+@pytest.fixture(name="renderer")
+def fixture_renderer(plugin):
+    """Return a PythonRenderer instance.
+
+    Parameters:
+        plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
+
+    Returns:
+        A renderer instance.
+    """
+    handler = plugin.handlers.get_handler("python")
+    handler.renderer._update_env(plugin.md, plugin.handlers._config)  # noqa: WPS437
+    return handler.renderer
diff --git a/tests/test_collector.py b/tests/test_collector.py
@@ -1,4 +1,4 @@
-"""Tests for the handlers.python module."""
+"""Tests for the `collector` module."""
 
 import pytest
 
diff --git a/tests/test_renderer.py b/tests/test_renderer.py
@@ -0,0 +1,33 @@
+"""Tests for the `renderer` module."""
+
+import pytest
+from griffe.docstrings.dataclasses import DocstringSection, DocstringSectionKind
+
+
+@pytest.mark.parametrize(
+    "renderer",
+    [
+        {"theme": "mkdocs"},
+        {"theme": "readthedocs"},
+        {"theme": {"name": "material"}},
+    ],
+    indirect=["renderer"],
+)
+def test_render_docstring_examples_section(renderer):
+    """Assert docstrings' examples section can be rendered.
+
+    Parameters:
+        renderer: A renderer instance (parametrized).
+    """
+    section = DocstringSection(
+        DocstringSectionKind.examples,
+        value=[
+            (DocstringSectionKind.text, "This is an example."),
+            (DocstringSectionKind.examples, ">>> print('Hello')\nHello"),
+        ],
+    )
+    template = renderer.env.get_template("docstring/examples.html")
+    rendered = template.render(section=section)
+    assert "<p>This is an example.</p>" in rendered
+    assert "print" in rendered
+    assert "Hello" in rendered

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""Tests for the handlers.python module."""`
	`1`	+"""Tests for the `collector` module."""
`2`	`2`
`3`	`3`	`import pytest`
`4`	`4`