Multi-line summary lines are cut.

[Viech]

I'm aware that docstring summary lines that are actually longer than one line are not PEP 257 compliant – but they do appear in practice, in particular if you have some markup in them. I suggest to treat any text up to the first blank line as the summary line.

[Viech]

I spent around two days on a PEP 257 refactoring as otherwise autoapi does pretty much what I want it to do. So on my end the issue is resolved. I still think this is a valid feature request that could save other users some trouble, in particular because other doc generators behave as proposed so switching over from one of them becomes easier.

[carlos-jenkins]

Hi @Viech

Thanks for the feedback. Indeed, I can agree with you. I suspect that the culprit could be this function:

autoapi/lib/autoapi/sphinx.py

Line 61 in 450dc1b

def filter_summary(obj):

Which is doing:

summary = doc.split('\n').pop(0)

This can be improved indeed. Will try to find time to identify how to do it better.

Thanks