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