Làm cách nào để ghi lại ngoại lệ bằng Sphinx

Question

Tôi không thể tìm ra cách ghi lại ngoại lệ bằng Sphinx.

Tôi đã thử những điều sau đây:

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 tiếp tục nói "danh sách Dòng kết thúc mà không có một dòng trống; unindent bất ngờ." Vậy làm cách nào để loại bỏ thông điệp và cách thích hợp để ghi lại có thể là nhiều ngoại lệ với tài liệu nhiều dòng?

Answer 1

Bạn có thể sử dụng một dấu gạch chéo để tiếp tục dòng:

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

Cập nhật:

thụt dường như làm việc thay vì thoát dòng mới:

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

Answer 2

điều này cho tôi mọi thứ tốt đẹp.

bạn quên : Trước khi tên ngoại lệ

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 

Lưu ý: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example có một số mẫu đẹp (không phải trên nhiều dòng ngoại lệ không may)