如何使用Sphinx生成Python包文档

Question

目前我这样做：

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. 我真的需要列举每一个模块吗？
2. 如何控制详细信息页的选项？

广告1:我想做这样的s.th (目前不起作用)：

.. autosummary:: package_1
   :toctree: _generated
   :members:

(或者可能是一个新的autopackage命令。)

广告2:我想通过一些选项，比如automodule或autoclass期望的选项，例如：

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

这似乎是一个显而易见的任务，所以我可能遗漏了一些信息。是否有一种简单的替代方法来实现这一目标？

Answer 1

感谢所有的评论者！

广告1:

我手动列出模块。

广告2:

最后，我使用了this和this提出的解决方案来回答类似的问题：

创建模板文件(_templates/autosummary/module.rst和_templates/autosummary/class.rst)并将其添加到

api_doc.rst:

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

   wsgidav._version
   wsgidav.compat