Sphinx autofunction生成没有换行符的python docstring

Question

我有一个简单的python包，其中包含以下函数的1个模块：

def sample_addition(num1=1, num2=2):
    """adding 2 numbers as an example

    this function will add 2 numbers in case of failre it will raise an exception
    @param num1: first number
    @type num1: float
    @param num2: second number
    @type num2: float
    @return: addition result
    @rtype: float
    """
    return num1 + num2

使用.. autofunction:: sample_addition make html导致：

general.sample_addition(num1=1, num2=2)
adding 2 numbers as an example

this function will add 2 numbers in case of failre it will raise an exception @param num1: first number @type num1: float @param num2: second number @type num2: float @return: addition result @rtype: float

我已经安装和使用sphinx_epytext里面conf.py -> extensions ，但它无助于正确转换并显示Epytext

题：

我怎样才能让它看到docstring中的新行？

Answer 1

就像markdown和rst一样，它需要newline来分隔不同的段落，你需要在this function...和@param ...之间添加换行符@param ...像这样：

def sample_addition(num1=1, num2=2):
    """adding 2 numbers as an example

    this function will add 2 numbers in case of failre it will raise an exception

    @param num1: first number
    @type num1: float
    @param num2: second number
    @type num2: float
    @return: addition result
    @rtype: float
    """

return num1 + num2