スフィンクスを使用して例外を文書化する方法

Question

スフィンクスを使用して例外を文書化する方法を理解できないようです。

私は次のことを試してみた：

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

Answer 2

これは私に何か良いものを与える。

あなたは

def some_funct(): 
    """ 
    :raise: 
     :IOException: a probleme occured 
         and it can't be passed 
    """ 

Answer 3

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はこれを使用して、いくつかの素敵なサンプル（いない複数行の例外で、残念ながら）