小编典典

Sphinx autodoc 不够自动化

all

我正在尝试使用 Sphinx 在 Python 中记录一个超过 5,000 行的项目。它有大约 7 个基本模块。据我所知,为了使用
autodoc,我需要为项目中的每个文件编写如下代码:

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

这太乏味了,因为我有很多文件。如果我可以指定我想要记录“mods”包会容易得多。然后,Sphinx 可以递归地遍历包并为每个子模块创建一个页面。

有这样的功能吗?如果不是,我可以编写一个脚本来制作所有 .rst 文件,但这会占用大量时间。


阅读 82

收藏
2022-07-01

共1个答案

小编典典

你可以查看 我制作的这个脚本。我认为它可以帮助你。

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

更新

该脚本现在作为 apidoc
成为 Sphinx 1.1 的一部分。

2022-07-01