Sphinx kullanarak istisna nasıl belgelenir

Question

Sphinx kullanarak istisnaların nasıl belgeleneceğini anlayamıyorum. "; Beklenmedik GİRİNTİSİZ Saha liste boş hat olmadan biter."

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

Sfenks söyleyip duruyor:

Aşağıdaki denedim Peki, bu iletiden nasıl kurtulurum ve çok satırlı belgelerle olası birden çok özel durumu belgelemenin doğru yolu nedir?

Answer 1

istisna adı önce : unutmak yeni satır:

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

Answer 2

Bu bana güzel bir şey verir. kaçmayı

Girintilenmiş iş gibi görünüyor yerine:

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

Güncelleme:

sen Satır devamı için ters eğik çizgi kullanabilirsiniz

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 

Not: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example bu kullanma