30

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

スフィンクスは言い続けます：

「フィールド リストは空白行なしで終了します。予期しないインデント解除です。」

では、どうすればメッセージを取り除くことができ、複数行のドキュメントで複数の例外をドキュメント化する適切な方法は何ですか?

4

4 に答える 4

38

行の継続にバックスラッシュを使用できます。

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

アップデート：

改行をエスケープする代わりに、インデントが機能しているようです。

def some_funct():
    """
    :raises ExceptionType: Some multi-line
        exception description.
    """
于 2013-04-12T14:04:57.967 に答える
2 
def some_funct():
    """
    My documentation, but watch the empty line below (necessary)

        :raise: Exception

            when status != my_status 
            | status <= max_status

注: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-exampleにはいくつかの優れたサンプルがあります (残念ながら複数行の例外ではありません)。

于 2014-10-08T10:56:07.960 に答える
0

これは私に何かいいものを与えてくれます。

:例外名の前を忘れた

def some_funct():
    """
    :raise: 
        :IOException: a probleme occured
                      and it can't be passed
    """
于 2013-04-12T13:36:35.700 に答える