Sphinx 1.4+和带有sphinx-napoleon的Return中的块文字不再起作用了

时间:2016-05-13 15:00:00

标签: python python-sphinx

我正在编写遵循本指南的python项目的文档:

http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

准确地说这部分指南:

Returns部分支持任何reStructuredText格式,包括文字块::

我的代码如下:

Returns:
    None:

    ::

        {
            "status": "update",
            "success": True,
        }

对于sphinx 1.3.5-1.3.6,它按预期工作。

对于sphinx 1.4.0-1.4.1,它会抛出错误:

api/v0_0/views.py:docstring of api.v0_0.views.add_gallery:19: ERROR: Unexpected indentation.
api/v0_0/views.py:docstring of api.v0_0.views.add_gallery:21: WARNING: Block quote ends without a blank line; unexpected unindent.

1 个答案:

答案 0 :(得分:0)

这是错误。我创建了一个带有工作示例的票据,如何重现它。在Sphinx工作的人已经在一周(或左右)修复了它。颠簸版将解决它。