根据sphinx文档(https://www.sphinx-
doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-
python-objects),可以在目标类之前使用点:
:class:`.ReallyLongExampleClassName`
要么
:class:`.module5.ReallyLongExampleClassName`
让狮身人面像搜索该类:
…如果名称前加点号,但未找到完全匹配的内容,则将目标作为后缀,并搜索带有该后缀的所有对象名称。例如,:py:meth:
.TarFile.close引用tarfile.TarFile.close()函数,即使当前模块不是tarfile。由于这可能会变得模棱两可,因此,如果可能存在多个匹配项,您将收到Sphinx的警告。
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)