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

问题描述

我对Shinx比较陌生，希望为我的一个项目生成文档。我的一个函数的示例可以在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命令时，文档几乎是正确的，但是返回类型和参数被附加到函数描述中，如下所示：

如何将paramreturn和rtype放在单独的行中？或者这就是文档的外观？

推荐答案

您需要在描述和第一个:param blah blah:之间添加一个空行。请参阅Info field lists的语法。

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

这篇关于为什么sphinx在同一行设置我的文档字符串参数的格式的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！