sphinx-resolve-py-references

一个用于修复或警告Python对象引用缺失的Sphinx扩展

该扩展很有用，因为它经常很麻烦要在文档中写出对象的完整路径，而这些对象你知道在当前模块中已经导入。对于相邻的模块也是如此，使用相对名称引用会更容易。

此扩展通过允许您将当前模块中导入的函数或类作为在那里定义的对象进行引用，并创建指向其实际位置的回链来解决这些问题。

from some_package import MyClass

def my_function():
    '''Uses :class:`MyClass`'''
    # The above reference would normally fail because `MyClass`
    # is not defined in this module. However this extension
    # automatically resolves the reference

这是通过分析AST以查找import语句并将它们回溯到目标定义的位置来完成的。这比查看类和函数的__module__和__name__属性更稳健，因为并非所有可文档化的对象都具有这些属性（例如全局变量）。