如何使用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。你知道吗

例如：我们有一个公共类package.submodule1.SubModule1Class。 作为包用户，我可以通过执行from package import SubModule1Class导入类。你知道吗

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

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

我可以使用apidoc上的哪些配置设置来实现此目标状态？我试过各种各样的方法，但都没有类似的方法。你知道吗

Answer 1

我提出的解决方案是使用Autosummary，这并不完全是我想要的，但已经足够好了。我必须将所有顶级类导入到我的索引.rst地址：

.. toctree::
   :hidden:

   self

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

   package.MyClass1
   package.MyClass2
   ...