我正在使用sphinx-apidoc和autosummary扩展来记录库的API，但我真的无法理解下面generated/选项的用途:
.. autosummary::
:nosignatures:
:toctree: generated/
module.function_1
module.function_2
...
我已经看过这是Sphinx文档，并且在类似pandas的库中。我正在使用
toctree，并且我的API正在自动生成，但是我不明白所生成的是什么。我看不到名为generate的文件夹，也不知道它的优点/目的是什么。谢谢
最佳答案
“generated”选项是Sphinx将自动生成的“stub” .rst文件放入其中的输出目录的名称。它不必被称为“生成的”。您可以使用任何名称。
当 autosummary_generate 配置变量设置为True时，Sphinx为 autosummary 指令中列出的每个条目生成一个.rst文件。例如，如果您要为包含多个类的模块编写文档，则可以使用此功能将每个类的完整文档放在单独的页面上。自动汇总表将包含指向这些页面的链接。