在sphinx中,python域使用
对于函数(使用
.. py:decorator::
来记录装饰器,但如何交叉引用装饰器?对于函数(使用
.. py:function::
记录),有:py:func:
。那么装饰器的等效语法是什么?.. py:decorator::
来记录装饰器,但如何交叉引用装饰器?.. py:function::
记录),有:py:func:
。那么装饰器的等效语法是什么?没有 py:deco 角色可以链接到使用此指令标记的修饰符; 而是使用 py:func 角色。 http://sphinx-doc.org/domains.html#directive-py:decorator
官方解决方案是使用 :py:func:
。它也可以工作。不幸的是,Sphinx 在修饰符名称后添加了括号。
text py:func:`mydecorator` text
text mydecorator() text
:func:\
@mydecorator()<mydecorator>`` 更改引用中的链接文本。如果您不需要括号,例如装饰器没有参数,则可以省略它们。 - Suor