如何使用Sphinx记录异常

Question

我似乎无法弄清楚如何使用Sphinx记录异常.

我尝试过以下方法:

def some_funct():
    """
    :raises: ExceptionType: Some multi-line
        exception description.
    """


def some_funct():
    """
    :raises: ExceptionType, Some multi-line
        exception description.
    """


def some_funct():
    """
    :raises ExceptionType: Some multi-line
        exception description.
    """


def some_funct():
    """
    :raises:
        ExceptionType: Some multi-line
            exception description.
    """

斯芬克斯一直说"场名列表没有空白线;意外的不连贯." 那么我如何摆脱信息以及用多行文档记录可能的多个异常的正确方法是什么？

Answer 1

您可以使用反斜杠进行续行:

def some_funct():
    """
    :raises ExceptionType: Some multi-line \
        exception description.
    """

更新:

缩进似乎工作而不是转义换行符:

def some_funct():
    """
    :raises ExceptionType: Some multi-line
        exception description.
    """