微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

如何解决如何在 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.Fooproject.datasets.Foo?或者以其他方式将 project.datasets.foo.Foo 指向 project.datasets.Foo 的文档? autodoc-process-bases 看起来很有前途,但尚未发布。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。