sphinx中的python域有.. py:decorator::
来记录装饰器,但如何交叉引用装饰器?
对于函数(用.. py:function::
记录),有:py:func:
。装饰器的等价物是什么?
答案 0 :(得分:1)
我在sphinx的文档中找到了答案:
没有py:deco角色链接到用该指令标记的装饰器;相反,使用py:func角色。 http://sphinx-doc.org/domains.html#directive-py:decorator
官方解决方案是使用:py:func:
。它也有效。不幸的是,sphinx在装饰者名称后面添加了括号。
text py:func:`mydecorator` text
成为输出:
text mydecorator() text
可以全局禁用brakets,但在引用实际函数时我非常喜欢它们。