我们使用 read-the-docs 和 sphinx 为 GitHub 上托管的包构建文档。该文档包括 .ipynb 文件(Python 笔记本),这些文件在 readthedocs 网页上呈现为 HTML。最近,readthedocs 构建已成功,但与 .ipynb 笔记本对应的一些 HTML 页面完全是空的。我在调试日志中找不到任何迹象表明为什么会发生这种情况,并且其他具有类似内容的笔记本也成功了。当我在计算机上本地构建文档时,笔记本的 HTML 渲染效果很好。
如何调试为什么会出现空 HTML 页面?
完整构建日志:https://app.readthedocs.org/projects/opensoundscape/builds/25880108/ 文档:https://opensoundscape.org/en/v0.11.0/
呈现为空白 HTML 页面的笔记本示例 https://opensoundscape.org/en/v0.11.0/tutorials/audio.html
笔记本 .ipynb 文件存在: https://opensoundscape.org/en/v0.11.0/tutorials/audio.ipynb
此外,即使我们回顾最初成功构建的旧“文档版本,例如
https://opensoundscape.org/en/v0.9.0/tutorials/audio_and_spectrogram.html
它们现在也是空白的!
但是,我们知道这些最初是作为 HTML 构建并成功呈现的:
因此,readthedocs 中似乎发生了一些更改,导致这些 html 渲染的笔记本在网站上托管时为空白。
任何有关如何解决此问题的想法将不胜感激。
这是新附加组件实现中的一个错误,该错误发生在内存占用较大的页面上,通常是由于嵌入图像(这是 ipynb 笔记本的默认设置)造成的 https://github.com/readthedocs/readthedocs.org/issues/11693
票证中建议的解决方法:
暂时,如果您遇到此错误,您可以禁用 为您的项目添加插件或尝试减少响应大小 页。如果您使用的是笔记本,您可以尝试将图像输出为 文件,而不是在图像的 HTML 中使用内联数据。