我正在尝试使用pdoc生成文档，其中我的文档字符串如下所示：
"""
I am a description of what a method does
:param param1: an integer
:param param2: a str
"""
我发现了这个问题：How to preserve line breaks when generating python docs using sphinx但建议在每行前加上|对我不起作用（它只是出现在这样）
| :param param1: an integer | :param param2: a str
在每一行的末尾都没有使用\ n的想法？
答案 0 :(得分：2)
所以，我一直有同样的问题。刚想通了。 Pdoc uses markdown。您希望在标记中使用softbreak来告诉它创建换行符，同时仍然保持分组。通过在要用新行结束的行的末尾放置两个尾随空格来实现软中断。
您可以查看本教程以了解我的意思。 http://www.markdowntutorial.com/lesson/7/
此外，请注意您使用的是哪种编辑器。它可能正在删除尾随空格！ Trailing spaces removed on Python heredoc lines in PyCharm
"""
I am a description of what a method does
:param param1: an integer <-- line ends right here with two spaces
:param param2: a str
"""