You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

Sphinx生成HTML出现定义列表未结束警告,求空行添加位置

解决Sphinx WARNING: Definition list ends without a blank line; unexpected unindent 警告

这个警告的核心问题是你的参数定义列表和:return:标签之间缺少了一个分隔空行——Sphinx的reStructuredText解析器依赖空行来识别「定义列表结束」的边界,没有空行的话,解析器会误以为定义列表还在继续,遇到:return:的缩进变化就会抛出警告。

你只需要在最后一个参数(end_time: - optional string,Segments)和:return:之间添加一个空行就能解决问题,修正后的文档字符串如下:

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
    """

另外顺便提个小建议:Sphinx更推荐用:param缩写标签来逐个标记参数,这样的写法更符合规范,生成的文档格式也会更整齐,比如:

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

    :return: Segments Object
    """

内容的提问来源于stack exchange,提问作者DennisLi

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.05.07 18:52:31