python - 如何防止 sphinx 显示我的类(class)的完整路径？

Question

我有一个这样的项目结构:

package/
    __init__.py
    module.py

__init__.py包含:

from .module import Class

module.py包含:

class Class:
    pass

使用 sphinx-apidoc -o package/docs/ package/和 sphinx-build package/docs/ package/docs/_build , Class 的文档看起来像这样:

class package.module.Class

     Bases: object

我想要这个输出:

class package.Class

     Bases: object

或者，更好的是，没有包名:

class Class

     Bases: object

用户不必知道类是在哪个文件中定义的；这些信息是完全不相关的，如果不是混淆的话。自 __init__.py正在进口 Class直接进入包的命名空间，用户将把这个类导入为 from package import Class , 不像 from package.module import Class ，我希望文档能够反射(reflect)这一点。

有没有办法让 sphinx 输出相对于包命名空间的路径？

Answer 1

尝试添加 add_module_names = False在 conf.py