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

Question

目前我这样做：

配置文件：

autosummary_generate = True

参考.rst：

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

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

这将为每个模块生成一个概览表，每个模块的条目都很好地链接到详细信息页面。

我有两个问题：

广告1.：我想做这样的事情（目前不起作用）：

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

（或者也许是一个新autopackage命令。）

广告 2.：我想传递那些automodule或autoclass期望的选项，例如：

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

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

score 0 · Accepted Answer

感谢所有评论者！

广告 1：
我手动列出模块。

广告 2：
我终于采用了这个提出的解决方案，并且回答了类似的问题：

创建模板文件（_templates/autosummary/module.rst和_templates/autosummary/class.rst）并将其添加到
api_doc.rst：

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

   wsgidav._version
   wsgidav.compat

1 回答 1