search

NiklasRosenstein / pydoc-markdown

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

SphinxProcess does not support multi-line parameter docstrings #195

Closed NiklasRosenstein closed 2 years ago

NiklasRosenstein commented 3 years ago

image image

timcharper commented 3 years ago

@NiklasRosenstein have you done any work on this? I was thinking the parser could be improved by having a pre-processor that splits the docstring in to contiguous chunks, where each chunk is defined as the subsequent lines being indented. Then, when the text chunk is checked for :param:, we're checking a chunk of text and not a line, so the whole chunk can be used as the param doc.

NiklasRosenstein commented 3 years ago

Hi @timcharper , I haven't. What you are suggesting sounds sane, would you like to make a contribution? 🙂

gmarks2149 commented 2 years ago

I've created a potential fix for this issue in #223 I'm not sure if that's a direction you want to go or not. I'm open to feedback.