Sphinx Napoleon Extension：使用 Google 样式文档字符串记录多个返回参数

Question

这个问题与另一个有关。 建议和接受的解决方案是：

Returns:
       (tuple): tuple containing:                        
                    arg1: First Argument
                    arg2: Second Argument

这个解决方案不起作用，至少对我来说是这样。 带有arg1和arg2描述的缩进子块不被解析。

我应该如何使用sphinx 、 sphinx.ext.napoleon和 Google Style docstring 管理多个回报？

Answer 1

这是一个已知问题， napoleon的当前维护者不会修复。 尽管如链接中所述，他们欢迎提供修复的拉取请求。

Answer 2

尝试在文档字符串中使用换行符\\n ：

Returns:
    tuple: tuple containing:

        servers (list): servers to use \n
        msg (str): logging message string