在Sphinx自动汇总指令中，这个&quot；生成&quot；选项是什么？ [英] What is this "generated" option in Sphinx autosummary directive?

问题描述

我正在使用sphinx-apidoc和autosumary扩展来记录某个库的API，但我真的无法理解以下generated/选项的用途：

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

   module.function_1
   module.function_2
   ...

我见过这是Sphinx文档，并且在像Pandas这样的库中。我正在使用toctree，我的API是自动生成的，但我不知道生成的是什么。我没有看到名为Generated的文件夹，也不知道这有什么好处/用途。

谢谢

推荐答案

"已生成"选项是Sphinx放置自动生成的"存根".rst文件的输出目录的名称。它不必称为"已生成"；您可以使用任何名称。

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

这篇关于在Sphinx自动汇总指令中，这个&quot；生成&quot；选项是什么？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！