Документ Сфинкса: Как вывести входной аргумент в предложении для другого аргумента? - PullRequest
Новая
       11

Документ Сфинкса: Как вывести входной аргумент в предложении для другого аргумента?

0 голосов
/ 08 декабря 2018

Моя функция Python выглядит следующим образом. 

def Foo(arg1: np.ndarray, arg2: np.ndarray):
    return arg1 + arg2

Я хочу добавить строку документации в reStructuredText с наполеоном (т. Е. Руководство по стилю Google Python). 

def Foo(arg1: np.ndarray, arg2: np.ndarray):
    """Some Function

    Args:
        arg1 (:class:`numpy.ndarray`): Some explanation.
        arg2 (:class:`numpy.ndarray`): Whose shape is the same with ``arg1``.
    """
    return arg1 + arg2

Однако в этомНапример, arg1 в объяснении arg2 является неоднозначным, поскольку Сфинкс не может судить, что arg1 совпадает с другим входным аргументом arg1.Как я могу явно выразить, что два arg1 это то же самое?

...