如何在 sphinx autodoc 中处理类导入别名

问题描述

我有一个具有以下目录结构的项目：

project
    datasets
        __init__.py
        foo.py
        bar.py

bar.py 定义了一个类 Bar，它继承自 Foo 中定义的 foo.py 类。在 __init__.py 中，我有以下导入别名：

from .foo import Foo
from .bar import Bar

__all__ = ("Foo","Bar")

这使用户可以轻松说出 from project.datasets import Bar，而无需担心 Bar 是在哪个文件中定义的。

我的问题是，当我去使用 Sphinx autodoc 时，nitpick 给了我以下警告：

project.datasets.bar.py:docstring of project.datasets.Bar:1: WARNING: py:class reference target not found: project.datasets.foo.Foo

有什么方法可以告诉 Sphinx autodoc project.datasets.foo.Foo 是 project.datasets.Foo？或者以其他方式将 project.datasets.foo.Foo 指向 project.datasets.Foo 的文档？ autodoc-process-bases 看起来很有前途，但尚未发布。

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

autodoc python python-sphinx