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

Question

If I take the very simple python file:

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

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

I get the type right after the parameter:

If I now use numpy style together with napoleon:

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

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

    """
    return parameter1

I end up with this ugly setup

The issue seems to be that nd_array is not a valid type which for the default sphinx does not seem to be a problem, but for napoleon this seems to matter, as for example type int works perfectly.

Answer 1

I am not sure if the following would work for nd_array , but I assume it should as it works for built-in types ( str , list , float , etc.). Here is a small example of what works for me:

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

Output: