python - 如何结合 sphinx docstring 在 numpy docstring 中正确添加嵌套列表

Question

我想知道如何实现以下目标。我将 numpy docstring 样式与 sphinx autodoc 结合使用来生成自动文档。但是，我正在努力在输出中有一个嵌套列表：

Attributes
----------
attribute 1: pandas data frame
    * `index:` Array-like, integer valued representing
          days. Has to be sorted and increasing.
    * `dtype:` float64. Value of temperature.
    * `columns:` location description, e.g. 'San Diego'
attribute 2: `int`
    nice and sunny days in California

此文档字符串的输出已完成。它无法识别属性 1 的列表。

另一方面，功能描述跨越多行：

def generate_temp(self, n, freq, very_long_variable_name,
                  type_temp=None, method=None):

同样在这里 sphinx 不识别完整的功能，并独立于第一行处理第二行。

我的格式有什么问题？

Answer 1

使用Napoleon 中的 NumPy 文档字符串，您需要在冒号两侧留一个空格。尝试这个：

Attributes
----------
attribute 1 : pandas data frame
    * `index:` Array-like, integer valued representing
      days. Has to be sorted and increasing.
    * `dtype:` float64. Value of temperature.
    * `columns:` location description, e.g. 'San Diego'
attribute 2 : `int`
    nice and sunny days in California

我不知道这是否可行，因为示例 NumPy 字符串表明仅支持段落。它没有提到任何关于列表的内容。