Sphinx Napoleon扩展:用Google风格文档字符串记录多个返回参数

Question

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

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

这个解决方案不工作，至少对我来说。不解析包含arg1和arg2描述的缩进子块。

我应该如何管理多个回报与sphinx, sphinx.ext.napoleon和谷歌风格文档字符串?

Answer 1

尝试在docstring中使用换行符n:

Returns:
    tuple: tuple containing:
        servers (list): servers to use n
        msg (str): logging message string 

Answer 2

这是sphinx项目(napoleon的当前维护者)不会修复的已知问题。正如链接中提到的，他们不认为多行返回是google规范的一部分，也不会修复这个问题。