Как получить такой же вывод из документов sphinx napoleon и numpy style, как при первом способе по умолчанию?

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 не является допустимым типом, который для сфинкса по умолчанию не является проблемой, но для наполеона это имеет значение, так как, например, тип int отлично работает.

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

Выход: