Question

我正在使用sphinx api-doc和autosummary扩展来记录库的API，我真的无法理解下面generated/选项的用途：

.. autosummary::
   :nosignatures:
   :toctree: generated/

   module.function_1
   module.function_2
   ...

我已经看到这是sphinx文档，并且在像pandas这样的库中。我正在使用toctree，我的API是自动生成的，但我不明白生成的是什么。我没有看到名为generated的文件夹，也不知道这是什么优点/目的。

由于

Answer 1

＆＃34;生成＆＃34; option是Sphinx自动生成的输出目录的名称＆＃34; stub＆＃34; .rst文件。它不必被称为＆＃34;生成＆＃34 ;;你可以用任何名字。

当autosummary_generate配置变量设置为True时，Sphinx会为autosummary指令中列出的每个条目生成一个.rst文件。例如，如果要记录具有多个类的模块，则可以使用此功能将每个类的完整文档放在单独的页面上。 autosummary表将包含指向这些页面的链接。