如何在Sphinx中交叉引用由autodoc生成的函数?

如何在Sphinx中交叉引用由autodoc生成的函数?,第1张

如何在Sphinx中交叉引用由autodoc生成的函数?

您不需要添加标签。为了引用Python类,方法或其他记录的对象,请使用Python域提供的标记

例如,以下定义了对该

mymethod
方法的交叉引用:

:py:meth:`mymodule.MyClass.mymethod`

或更简单(因为Python域是默认域):

:meth:`mymodule.MyClass.mymethod`

TextWrapper.wrap
在问题中链接到的文档包括两个此类交叉引用(单击“显示源”以查看reST标记)。



欢迎分享,转载请注明来源:内存溢出

原文地址: https://outofmemory.cn/zaji/5645361.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-12-16
下一篇 2022-12-16

发表评论

登录后才能评论

评论列表(0条)

保存