I can't seem to figure out how to document exceptions using Sphinx.
I've tried the following:
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 keeps saying:
"Field list ends without a blank line; unexpected unindent."
So how do I get rid of the message and what is the proper way to document possibly multiple exceptions with multiple-line documentation?
You can use a backslash for line continuation:
def some_funct():
"""
:raises ExceptionType: Some multi-line \
exception description.
"""
Update:
Indenting seems to work instead of escaping the newline:
def some_funct():
"""
:raises ExceptionType: Some multi-line
exception description.
"""