如何从狮身人面像拿破仑和numpy样式文档中获取与默认rst方法相同的输出?

时间:2019-06-16 16:46:35

标签: python python-sphinx sphinx-napoleon

如果我使用非常简单的python文件:

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

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

我在参数后面得到类型:

enter image description here

如果我现在与拿破仑一起使用numpy风格:

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

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

    """
    return parameter1

我最终完成了这个丑陋的设置

enter image description here

问题似乎是nd_array不是有效的类型,对于默认的狮身人面像似乎没有问题,但是对于拿破仑来说,这似乎很重要,例如类型int有效完美。

1 个答案:

答案 0 :(得分:0)

我不确定以下内容是否适用于nd_array,但我认为它应该适用于内置类型(strlistfloat等)。这是一个对我有用的小例子:

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('_')

输出:

enter image description here