Sphinx autodoc不够自动化

Question

我正在尝试使用Sphinx在Python中记录5,000多个项目。它有大约7个基本模块。据我所知，为了使用自动文档，我需要为项目中的每个文件编写如下代码：

.. automodule:: mods.set.tests
    :members:
    :show-inheritance:

这太繁琐了，因为我有很多文件。如果我只想指定要记录的“ mods”包，那会容易得多。然后，Sphinx可以递归地浏览包并为每个子模块创建一个页面。

有这样的功能吗？如果没有，我可以编写一个脚本来制作所有.rst文件，但这将花费很多时间。

Answer 1

您可以检查我编写的此脚本。我认为它可以帮助您。

该脚本解析目录树以查找python模块和软件包，并适当地创建ReST文件以使用Sphinx创建代码文档。它还创建一个模块索引。

更新

现在，此脚本作为 apidoc 是Sphinx 1.1的 一部分 。