在使用 Sphinx 构建文档的最后记录
Logging at the end of building docs with Sphinx
一些背景:
在使用 sphinx 构建库的文档时,我使用自定义指令测量了一些渲染时间(用于使用该库渲染视频)并将它们保存到 csv 文件中。为了获得可读的日志,我不想立即打印它们,但是一旦所有这些都已 运行,例如就在构建日志的末尾。我已经有了生成该渲染摘要的脚本。
真题:
我需要在哪里调用我的日志记录脚本,以便它在“读取源代码”步骤完成后执行一次?我真的不关心它被添加到日志的确切位置。
Sphinx 定义了几个 事件 可用于触发事件处理程序(通过 setup()
函数)。我不确定哪个事件最适合你的情况,但这里是核心事件列表:
https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events
一些背景:
在使用 sphinx 构建库的文档时,我使用自定义指令测量了一些渲染时间(用于使用该库渲染视频)并将它们保存到 csv 文件中。为了获得可读的日志,我不想立即打印它们,但是一旦所有这些都已 运行,例如就在构建日志的末尾。我已经有了生成该渲染摘要的脚本。
真题:
我需要在哪里调用我的日志记录脚本,以便它在“读取源代码”步骤完成后执行一次?我真的不关心它被添加到日志的确切位置。
Sphinx 定义了几个 事件 可用于触发事件处理程序(通过 setup()
函数)。我不确定哪个事件最适合你的情况,但这里是核心事件列表:
https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events