python - 如何从 sphinx napoleon 和 numpy 样式文档中获得与默认 rst 方式相同的输出？

Question

如果我采用非常简单的python文件：

def magic_function(parameter1):
    """
    Do magic with parameter1.

    :param parameter1: The first of all paramters
    :type parameter1: nd_array
    """
    return parameter1

我在参数之后得到类型：

如果我现在将 numpy 样式与拿破仑一起使用：

def magic_function(parameter1):
    """
    Do magic with parameter1.

    Parameters
    ==========
    parameter1: nd_array
        The first of all paramters

    """
    return parameter1

我最终得到了这个丑陋的设置

问题似乎是它nd_array不是一个有效的类型，对于默认的狮身人面像似乎不是问题，但对于拿破仑来说这似乎很重要，例如 typeint工作得很好。

Answer 1

我不确定以下是否适用于nd_array，但我认为它应该适用于内置类型（str、list、float等）。这是一个对我有用的小例子：

def get_case_id_from_file_name(file_name):
    """ Retrieve case ID from file name.

    Parameters
    ----------
    str file_name
        Name of the test file to retrieve the case ID from.

    Returns
    -------
    list
        A list of split file name with case ID in it.
    """
    return file_name.split('_')

输出：