gpt4 book ai didi

python - Sphinx 自动摘要指令中的 "generated"选项是什么?

转载 作者:行者123 更新时间:2023-12-02 09:13:10 26 4
gpt4 key购买 nike

我正在使用 sphinx-apidoc 和自动摘要扩展来记录库的 API,但我真的无法理解下面的 generate/ 选项的用途:

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

module.function_1
module.function_2
...

我已经看到这是 Sphinx 文档,以及 pandas 等库中的内容。我正在使用 toctree 并且我的 API 正在自动生成,但我不明白生成的是什么。我没有看到名为 generated 的文件夹,也不知道它的优点/目的是什么。

谢谢

最佳答案

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

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

关于python - Sphinx 自动摘要指令中的 "generated"选项是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27350467/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com