sphinx.ext.duration -- 测量Sphinx处理持续的时间

在 2.4 版本加入.

此扩展测量Sphinx处理持续的时间，对于检查构建缓慢的文档非常有用。在构建结束时在控制台输出统计结果，而且默认将结果保存到输出目录的一个json文件

通过在 conf.py 的 extensions 列表中添加 'sphinx.ext.duration' 来启用此扩展：

extensions = [
    ...
    'sphinx.ext.duration',
]

配置

duration_print_total
类型:
bool
默认:
True

在构建摘要中显示总的读取持续时间，例如：

====================== total reading duration ==========================
Total time reading 31 files: 0m 3.142s

在 9.0 版本加入.

duration_print_slowest
类型:
bool
默认:
True

在构建摘要中显示最慢的持续时间。持续时间按从慢到快的顺序排序。这将打印最多 duration_n_slowest 个持续时间，例如：

====================== slowest 5 reading durations =======================
0.012s spam
0.011s ham
0.011s eggs
0.006s lobster
0.005s beans

在 9.0 版本加入.

duration_n_slowest
类型:
int
默认:
5

启用 duration_print_slowest 时，在构建摘要中显示的最慢持续时间的最大数量。默认情况下，仅显示 5 个最慢的持续时间。将此值设置为 0 以显示所有持续时间。

在 9.0 版本加入.

duration_write_json
类型:
str | None
默认:
'sphinx-reading-durations.json'

将所有读取持续时间写入输出目录中的JSON文件。文件内容是文档名称到读取持续时间的映射，其中文档名称是字符串，持续时间是以秒为单位的浮点数。将此值设置为空字符串或 None 以禁用写入文件，或将其设置为相对路径以自定义它。

这对于测试和设置读取时间限制可能很有用。

在 9.0 版本加入.

duration_limit
类型:
float | int | None
默认:
None

为读取文档设置持续时间限制（以秒为单位）。如果任何持续时间超过此值，将发出警告。

在 9.0 版本加入.