Sphinx autosummary指令中的此“生成”选项是什么？

Question

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

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

   module.function_1
   module.function_2
   ...

我已经看到了狮身人面像文档，以及像熊猫这样的库。我正在使用toctree，并且我的API正在自动生成，但是我不知道生成的是什么。我看不到名为generate的文件夹，也不知道这是什么优点/目的。

谢谢

Answer 1

“ generated”选项是Sphinx将自动生成的“ stub” .rst文件放入其中的输出目录的名称。它不必被称为“生成的”。您可以使用任何名称。

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