python - Sphinx 与 Python 函数交叉引用的问题

Question

我在 Sphinx 中的函数交叉引用方面遇到一些问题。只要我只有一个模块，像 :func:`myfunc` 这样的东西就可以正常工作，我可以单击链接来访问引用的函数。

但是，添加更多模块会破坏链接，我无法再单击它。解决这个问题的唯一方法是列出函数的完整名称::func:`mymodule.mysubmodule.MyClass.myfunc`。这有点烦人，特别是因为整个名称也显示在 html 页面中。

有没有办法至少在 html 文档中缩短链接的名称？IE。您只读取 myfunc 而不是 mymodule.mysubmodule.MyClass.myfunc？

谢谢!

Answer 1

有两件事可能会有用:

• 如果您当前的模块(使用 .. currentmodule:: 设置)与链接的模块一致，则不必显式指定它。您还可以从另一个类的文档字符串中引用其中一个类方法。来自 doc :

Normally, names in these roles are searched first without any further qualification, then with the current module name prepended, then with the current module and class name (if any) prepended. If you prefix the name with a dot, this order is reversed.

• 如果您在全名前加上 ~ 前缀，例如:func:`~mymodule.mysubmodule.MyClass.myfunc` , HTML 只会包含最后一部分。