使用intersphinx解决Sphinx中引用中的名称冲突

时间:2013-02-03 11:23:34

标签: python documentation python-sphinx

我正在为我的python库编写文档使用sphinx,我还在intersphinx中添加了另一个sphinx文档。它的工作非常好,但是我的一些函数的命名方式与引用文档中的相同,这会导致:func:...引用它们的名称。

有什么办法可以在其他文档中引用阴影函数do_some()吗? (:func:`do_some`创建指向我的函数do_some())的链接

1 个答案:

答案 0 :(得分:6)

根据docs,您可以使用intersphinx_mapping中的标识符 目标的前缀。例如:

:ref:`comparison manual <python:comparisons>`

我认为这也适用于使用函数。