#2670·pyro

使用 sphinx_gallery 自动渲染代码示例

作者: eb8680创建于 2020年10月14日更新于 2025年7月27日
标签help wantedwebsiteExamplesgood first issue

目前,我们的非笔记本电脑示例通过自定义的 .rst 文件手动包含在示例网页中,tutorial/source/ 目录下。 随着示例数量的增加,最好遵循 NumPyro 的方法 并使用 sphinx_gallery 自动生成 HTML 页面。 这样可以使示例更容易找到和阅读,改善教程页面的设计,并清理我们在 GitHub 上的教程文件夹。 许多示例还包含大量的文档字符串和注释,sphinx_gallery 可以自动将这些内容渲染为 HTML。 更大胆地讲,我们甚至可以使用 sphinx_gallery 在 ReadTheDocs 中包含教程,简化我们的发布过程,消除新教程在 GitHub 上添加后在示例网页上可见的延迟。