为什么 sphinx 在同一行上格式化我的文档字符串参数

Question

我对 sphinx 比较陌生，想为我的项目生成文档。我的函数之一的示例可以在 Predict.py 中找到：

def arima_rolling_forecast(training_set, testing_set, order, solver='lbfgs'):
    """
    Runs an ARIMA rolling forecast with a given training and testing set.
    :param pandas.Series training_set: training set.
    :param pandas.Series testing_set: testing set.
    :param collections.namedtuple order: ARIMA order (p, d, q).
    :param string solver: the solver used for the rolling average. Defaults to lbfgs.
    :return: the forecast of predicted values.
    :rtype: list
    """
    previous_results = list(training_set)
    predictions = []
    for result in testing_set:
        tmp_model = ARIMA(previous_results, order=order)
        tmp_model_fit = tmp_model.fit(disp=False, solver=solver)
        forecast, _, _ = tmp_model_fit.forecast()
        predictions.append(forecast[0])
        previous_results.append(result)
    return predictions

当我使用该make html命令时，文档几乎是正确的，但是返回类型和参数附加到函数描述中，如下所示：

如何更改此设置以便将param return和rtype放在单独的行上？或者这就是文档的本来面目？

Answer 1

您需要在描述和第一个 之间添加一个空行:param blah blah:。请参阅信息字段列表的语法。

我不确定是否支持 pandas 数据类型。您需要自己进行研究才能做出决定。