如何在numpy docstring中与sphinx 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

此docstring的输出已完成。它无法识别属性1的列表。

另一方面，函数描述跨越多行：

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

此处，sphinx无法识别完整的功能，并且独立于第一行处理第二行。

我的格式有什么问题？

Answer 1

使用NumPy docstrings in Napoleon，您需要在冒号两侧留出空格。试试这个：

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

我不知道这是否有效，因为example NumPy strings表示只支持段落。它没有提到有关列表的任何内容。