我是否必须为每个新模块（文件）运行sphinx-apidoc？

Question

为了熟悉Sphinx，我习惯使用Doxygen进行文档编制，它会从源代码中自动生成存根和类。

对于Sphinx，似乎每个新模块/文件我必须运行sphinx-apidoc -o dir dir，就像你必须在git中git add file一样，是这个标准还是有一个我缺少的设置标志。

我知道我可以自动执行bash / bat文件来按顺序运行每个命令。如果我做错了什么我很好奇。

以防有人问我是否启用了这些扩展并导入了本地路径。

conf.py

import os
import sys
sys.path.insert(0, os.path.abspath('.'))
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.coverage',
    'sphinx.ext.viewcode',
]

Answer 1

您不必为每个文件运行sphinx-apidoc。

  

sphinx-apidoc生成源文件，使用sphinx.ext.autodoc记录所有找到的模块。 sphinx-apidoc-manual-page

因此，如果您的项目被组织为标准python模块，这基本上意味着您已在每个模块文件夹中添加了__init__.py文件。 sphinx-apidoc应自动找到它们。