Python sphinx 如何使用Sphinx生成Python包文档

目前我这样做：

conf.py：

autosummary_generate = True

reference.rst：

package_1
---------
.. autosummary::
   :toctree: _generated

   package_1.module_1
   package_1.module_2
   package_1.module_3
   ...

这将为每个模块生成一个概览表，其中包含每个模块的条目 这很好地链接到详细页面

我有两个问题：

我真的必须列举每个模块吗

如何控制详细信息页面的选项

广告1： 我想这样做s.th（目前不起作用）：

（或者可能是一个新的

autopackage

命令。）

广告2： 我希望传递像

automodule

或

autoclass

期望的选项，例如：

.. autosummary::
   :toctree: _generated
   :undoc-members:
   :private-members:

这似乎是一项显而易见的任务，所以我可能遗漏了一些信息。

---

有没有一种简单的替代方法来实现这一点？

感谢所有的评论者

广告1:
我手动列出模块

广告2:
我最终同意了由提出的解决方案，并回答了类似的问题：

创建模板文件（

\u templates/autosummary/module.rst

和

\u templates/autosummary/class.rst

）并将其添加到
api\u文件rst:

Package ``wsgidav``
-------------------
.. autosummary::
   :toctree: _autosummary

   wsgidav._version
   wsgidav.compat

---

看看如何在rST中生成存根页，从中生成文档。和有一个类似的工具链。类似的问题：@StevePiercy据我所知，

autosummary_generate=True

是等效的（）@mzjn你是对的：你链接到的问题是类似的。它为“广告2”提供了一个解决方案。这是我问题的一部分。你会建议创建一个自定义模板吗（对我来说似乎有点复杂，但无论如何）？@mar10我不知道两者之间可能有什么不同，如果有的话，所以我不知道它们是否等效。建议尝试比较和对比，因为从阅读文档中发现差异是乏味的。TBH，这是我第一次看到sphinx autogen。

Package ``wsgidav``
-------------------
.. autosummary::
   :toctree: _autosummary

   wsgidav._version
   wsgidav.compat