python - 如何使用 Sphinx 标记引用记录在案的 Python 函数参数？

Question

我想在 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 文档，但没有找到这个问题的答案，也没有找到演示正确标记的示例。)

Answer 1

没有简单的方法可以使用 sphinx 直接引用函数的参数，而且我不知道这个问题的扩展。

documentation of the python domain解释了哪些对象可以被交叉引用。

为用户提供对函数 foo 的参数 bar 的引用的一种可能方法是

See parameter ``bar`` in :func:`foo`.

也许可以通过编写扩展来直接引用。