NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
449 stars 104 forks source link

Good formatting for "Examples" in docstring #284

Closed jeffchuber closed 1 year ago

jeffchuber commented 1 year ago

I am trying to render Examples in a docstring.

Examples:
            >>> client.get_or_create_collection("my_collection")
            collection(name="my_collection", metadata={})

however this is the end result html and rendering on the page

**Examples**:

  >>> client.get_or_create_collection("my_collection")
  collection(name="my_collection", metadata={})

Image screenshot

Screenshot 2023-05-08 at 8 51 33 PM

How can I extend the processor to support this kind of docstring?

jeffchuber commented 1 year ago

Ended up doing this! https://github.com/NiklasRosenstein/pydoc-markdown/issues/226