Sphinx Napoleon Extension:使用Google Style docstrings记录多个返回参数

时间:2015-07-14 17:59:00

标签: python python-sphinx google-style-guide

此问题与this other one有关。建议和接受的解决方案是:

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

此解决方案无效,至少对我而言。不解析具有arg1arg2描述的缩进子块。

如何使用sphinxsphinx.ext.napoleon和Google Style docstring管理多个退货?

2 个答案:

答案 0 :(得分:0)

napoleon的当前维护者won't be fixed已知这是一个已知问题。虽然如链接所述,但他们欢迎提出修复的拉取请求。

答案 1 :(得分:0)

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

Returns:
    tuple: tuple containing:

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