如何防止sphinx显示类的完整路径?

2024-04-24 21:19:40 发布

您现在位置:Python中文网/ 问答频道 /正文

我有这样一个项目结构:

package/
    __init__.py
    module.py

__init__.py包含:

^{pr2}$

module.py包含:

class Class:
    pass

使用sphinx-apidoc -o package/docs/ package/sphinx-build package/docs/ package/docs/_buildClass的文档如下所示:

class package.module.Class

     Bases: object

我希望使用以下输出:

class package.Class

     Bases: object

或者,更棒的是,没有包名:

classClass

     Bases: object

用户不必知道类是在哪个文件中定义的;如果不是混淆的话,这些信息是完全无关的。由于__init__.py直接将Class导入到包的命名空间中,所以用户将把这个类作为from package import Class导入,而不是作为from package.module import Class,我希望文档反映这一点。在

有没有办法让sphinx输出相对于包名称空间的路径?在


Tags: 用户from文档pybuilddocspackageobject