我想在 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 文档,但没有找到这个问题的答案,也没有找到演示正确标记的示例。)
没有简单的方法可以直接引用函数的参数sphinx
我不知道这个问题的扩展。
The python 域的文档 https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects解释哪些对象可以交叉引用。
为用户提供参数参考的可能方法bar
功能的foo
将会
See parameter ``bar`` in :func:`foo`.
也许可以通过编写扩展来直接引用。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)