Closed glenn-jocher closed 1 year ago
Thanks for the report!
PyCon code blocks are only recognized in Examples
sections (plural), not in Example
ones (which are parsed and rendered as admonitions). This is documented here: https://mkdocstrings.github.io/griffe/docstrings/#examples.
In the future such code blocks will be recognized anywhere thanks to a Markdown extension. This is in our backlog, therefore I'll close this issue :slightly_smiling_face:
Describe the bug Google-style
Example:
>>>
code blocks not rendering correctly in mkdocs using mkdocsmaterial with mkdocstrings.Original socstring
Mkdocs serve results
My
plugins
section of mkdocs.yaml looks like this:To Reproduce
Build docs with this example function:
Expected behavior
Expect code to render correctly with python highlights.
System (please complete the following information):
griffe
version: 0.32.1