我可以阻止 sphinx numpydoc 将 Returns 分成两部分吗

Question

使用 sphinx numpydoc 时，我记录了 Returns 部分。

Returns
-------
out: float
    A sentence about the return type

但是，渲染后它分为两部分。

Returns:

    out - A sentence about the return type

Return type:

    float

如何防止此部分被拆分并且只有退货部分？ “返回”部分的呈现方式与“参数”部分一样。

如果这很重要，我正在使用 pydata sphinx 主题。

Answer 1

如果您使用

sphinx.ext.napoleon

扩展，请在

conf.py

文件中设置以下选项：

napoleon_use_rtype = False

该类型将与返回值的描述一起出现在 Returns 标题下。如果您提供了返回值名称，它将出现在返回值名称后面的括号中。有关更多详细信息，请参阅文档中的页面：https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_use_rtype