Jak dokumentować wyjątek za pomocą Sphinx'a

Question

Nie mogę się domyślić, jak dokumentować wyjątki za pomocą Sphinx.

Próbowałem następujące:

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

Sphinx powtarza "lista Pole kończy się bez pustej linii; nieoczekiwany unindent". Jak więc pozbyć się wiadomości i jaki jest właściwy sposób dokumentowania możliwie wielu wyjątków za pomocą wieloliniowej dokumentacji?

Answer 1

można użyć backslash na linii kontynuacji:

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

Aktualizacja:

Wcięcia wydaje się działać zamiast ucieczki nowa linia:

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

Answer 2

daje mi to coś miłego.

zapomnienia : przed nazwą wyjątków

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 

Uwaga: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example posiada kilka próbek (nie wyjątkiem multi-line niestety)