意外的缩进 python-sphinx

Question

我的 python 项目中有以下 docString：

def challenge():
    """Route for POST a challenge.

    For call this route, we need to pass a serialNumber on body form.
    If this serialNumber is in the database and corresponds to a tablet we call methods for create challenge

    :returns: An HTTP response with a challenge

    EXAMPLE::
        REQUEST
            curl --location --request POST 'xxxx:xxxx/challenge'
            --form 'serialNumber="xxxxx"'
        RESPONSE
            {
                "challenge": "xxxx"
            }

    """

当我运行生成 html 时，sphinx 给我以下错误：

docstring of src.modules.challenge.router.challenge:15: WARNING: Definition list ends without a blank line; unexpected unindent.

格式完全不是我想要的文档格式。我希望我的 API 的每个路由都以文本块或代码块的形式插入请求/响应的示例。

Answer 1

在EXAMPLE::和REQUEST之间加一个空行。

块（段落）必须用空行与其他块分开。参见 https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks。

意外的缩进 python-sphinx

Unexpected unindent python-sphinx

python

docstring

python-sphinx