Python Sphinx警告:定义列表结束时没有空行;出人意料的不速之客

Python Sphinx警告:定义列表结束时没有空行;出人意料的不速之客,python,python-sphinx,Python,Python Sphinx,我的医生是这样的: 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: - op

我的医生是这样的:

    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.
我不知道应该在哪里加一个空行


我搜索过了,但没有找到任何与我类似的案例

jonrsharpe在评论中已经回答了这个问题,但我想在这里完成它

您正在使用默认的斯芬克斯样式

您必须在每行上添加“: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
    """

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

jonrsharpe已经在评论中回答了这个问题,但我想在这里完成它

您正在使用默认的斯芬克斯样式

您必须在每行上添加“: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
    """

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

我想在
:return:
行之前,这就是您的
:参数列表的结尾。哦,您是对的,您能告诉我在其他文档上这种格式叫什么吗?(比如谷歌格式或numpy?),我使用像
:param name:xxx
这样的格式,在
:return:
之前不需要空行,当你在每一行重复
:param[eter]
时,你不需要创建定义列表,所以你没有任何东西可以以空行结束。好的,我明白了。你能留下一个答案吗,我会接受的,谢谢。你尝试使用的格式既不是谷歌也不是Numpy风格。除非启用napoleon扩展,否则它是Sphinx使用的默认格式。看。我猜在
:return:
行之前,这就是你的
:参数列表的结尾。哦,你是对的,你能告诉我在其他文档上这种格式叫什么吗?(比如谷歌格式或numpy?),我使用像
:param name:xxx
这样的格式,在
:return:
之前不需要空行,当你在每一行重复
:param[eter]
时,你不需要创建定义列表,所以你没有任何东西可以以空行结束。好的,我明白了。你能留下一个答案吗,我会接受的,谢谢。你尝试使用的格式既不是谷歌也不是Numpy风格。除非启用napoleon扩展,否则它是Sphinx使用的默认格式。请参阅。对于future me,请删除第一个
参数上方的空格,并确保
return
写为
:return:
返回问题可能不如空格问题重要。未来通知结束。对于未来me,请删除第一个
参数上方的空格,并确保
返回
写为
:返回:
返回问题可能不如空格问题重要。未来通知结束。