python - 如何使用 Sphinx apidoc 仅记录在 __init__.py 中导入的 Python 类？

Question

所以目前我正在使用 apidoc 为我的文档生成 .rst 文件，然后在它们上使用 autodoc。问题是我的包将代码分成许多不同的文件，这导致了这种嵌套混乱（我的目录树的最大深度为 4）：

Welcome to (package)'s documentation!
Contents:
- (package)
    - (package) package
        - subpackages
            - package.subpackage1 subpackage
            - ...
        - submodules
            - package.submodule1 module
- module contents

我们将所有相关类导入__init__.py包的基础。

举个例子：我们有一个 public class package.submodule1.SubModule1Class。作为包用户，我可以通过from package import SubModule1Class) 导入类。

我想从我们在这个__init__.py平面层次结构中导入的所有类中自动生成文档，如下所示：

Welcome to (package)'s documentation!
Contents:
- SubModuleClass1
- SubModuleClass2
- SubModuleClass3
...

我可以使用 apidoc 上的哪些配置设置来实现此目标状态？我尝试了各种各样的东西，但没有任何东西与此类似。

Answer 1

我想出的解决方案是使用Autosummary，这不是我想要的，但做得足够好。我必须将所有顶级类导入我的 index.rst：

.. toctree::
   :hidden:

   self

.. autosummary::
   :toctree: stubs
   :nosignatures:

   package.MyClass1
   package.MyClass2
   ...