Python Sphinx 警告：定义列表结尾没有空行；意想不到的意外

Question

我的文档是这样的：

    def segments(self, start_time=1, end_time=9223372036854775806, offset=0, size=20):
        """Get segments of the model

        :parameter
            offset: - optional int
            size: - optional int
            start_time: - optional string，Segments 
            end_time: - optional string，Segments 
        :return: Segments Object
        """

当我制作html时，结果是：

 WARNING: Definition list ends without a blank line; unexpected unindent.

我不知道应该在哪里添加一个空行？

我搜索了SO，但找不到与我类似的案例。

Answer 1

问题已由 jonrsharpe 在评论中回答，但我想在这里完成。

您正在使用默认的 Sphinx 样式 "reStructuredText"

你必须在每一行添加“:parameter”:

    """Get segments of the model
    
    :parameter offset: optional int
    :parameter size: optional int
    :parameter start_time: optional string，Segments 
    :parameter end_time: optional string，Segments 
    :return: Segments Object
    """

如果您创建了一个专用的定义列表，那么在最后一个定义之后需要一个空行。在这种情况下，您可以这样做，但不必总是这样做。

Python Sphinx 警告：定义列表结尾没有空行；意想不到的意外

Python Sphinx WARNING: Definition list ends without a blank line; unexpected unindent

python

python-sphinx