sphinx_gallery.interactive_example#

Binder 和 JupyterLite 实用函数。

与 Binder 和 JupyterLite 的集成处于实验阶段。请注意，此 API 可能会在将来发生更改。

警告

Binder 仍处于 beta 阶段，因此点击 Binder 链接的用户可能会遇到不稳定性。

函数#

sphinx_gallery.interactive_example.check_binder_conf(binder_conf)[source]#: 检查以确保 Binder 配置正确。

sphinx_gallery.interactive_example.check_jupyterlite_conf(jupyterlite_conf, app)[source]#: 返回包含默认值的完整 JupyterLite 配置。

sphinx_gallery.interactive_example.copy_binder_files(app, exception)[source]#: 复制所有 Binder 需求和笔记本文件。

sphinx_gallery.interactive_example.create_jupyterlite_contents(app, exception)[source]#: 根据“jupyterlite”配置创建 JupyterLite 内容。

sphinx_gallery.interactive_example.gen_binder_rst(fpath, binder_conf, gallery_conf)[source]#

生成 Binder 徽章的 reST + 链接。

参数:

fpath (str) – 将生成 Binder 徽章的 .py 文件的路径。
binder_conf (dict 或 None) –
如果是一个字典，它必须包含以下键

’binderhub_url’
运行 Binder 服务的 BinderHub 实例的 URL。

’org’
文档将被推送到的 GitHub 组织。

’repo’
文档将被推送到的 GitHub 存储库。

’branch’
文档存在的 Git 分支（例如，gh-pages）。

’dependencies’
与 Binderspec 匹配的依赖文件路径列表。
gallery_conf (dict) – Sphinx-Gallery 配置字典。

返回值:

rst – 指向此文件的 Binder 徽章的 reStructuredText。

返回类型:

str

sphinx_gallery.interactive_example.gen_binder_url(fpath, binder_conf, gallery_conf)[source]#

根据 conf.py 中的配置生成 Binder URL。

参数:

返回值:

binder_url – 可用于将用户引导到实时 Binder 环境的 URL。

返回类型:

str

sphinx_gallery.interactive_example.gen_jupyterlite_rst(fpath, gallery_conf)[source]#

生成 Binder 徽章的 reST + 链接。

参数:

返回值:

rst – 指向此文件的 JupyterLite 徽章的 reStructuredText。

返回类型:

str

sphinx_gallery.interactive_example.post_configure_jupyterlite_sphinx(app, config)[source]#

检查 SG “jupyterlite” 并更新 JupyterLite 配置“jupyterlite_contents”。

连接到“config-inited”事件，但优先级较低，因此在 pre_configure_jupyterlite_sphinx 之后调用。

sphinx_gallery.interactive_example.pre_configure_jupyterlite_sphinx(app, config)[source]#

如果启用了 jupyterlite，配置 ‘jupyterlite_bind_ipynb_suffix’。

连接到“config-inited”事件。