Come documentare un'eccezione usando Sfinge

Question

Non riesco a capire come documentare le eccezioni usando Sphinx.

ho provato la seguente:

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

Sfinge continua a dire "lista campo si conclude senza una riga vuota; unindent inaspettato." Quindi, come faccio a sbarazzarmi del messaggio e quale è il modo corretto di documentare eventualmente più eccezioni con la documentazione su più righe?

Answer 1

È possibile utilizzare una barra rovesciata per la continuazione di riga:

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

Aggiornamento:

Rientro sembra funzionare, invece di fuggire la nuova riga:

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

Answer 2

questo mi dà qualcosa di bello.

si dimentica la : Prima il nome dell'eccezione

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 

Nota: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example ha alcuni campioni belle (non sul l'eccezione multilinea purtroppo)