Как сослаться на задокументированный параметр функции Python с помощью разметки Sphinx?

Я хотел бы сослаться на ранее задокументированный параметр функции в другом месте в строке документации Python. Рассмотрим следующее (по общему признанию полностью искусственный) пример:

def foo(bar):
    """Perform foo action
    :param bar: The bar parameter
    """

    def nested():
        """Some nested function that depends on enclosing scope's bar parameter.
        I'd like to reference function foo's bar parameter here
        with a link, is that possible?"""
        return bar * bar

    # ...
    return nested()

Есть ли простой способ встроить ссылку на параметр с помощью разметки Sphinx, или это произойдет автоматически?

(Я полный новичок в Sphinx. Я просматривал документы Sphinx и нашел не нашел ответа на этот вопрос или примера, демонстрирующего правильную разметку.)

38
задан bmu 8 February 2013 в 09:24
поделиться