sphinx_gallery.notebook#
Jupyter 笔记本的解析器。
保存 Jupyter 笔记本信息的类
函数#
- sphinx_gallery.notebook.add_code_cell(work_notebook, code)[source]#
向笔记本添加代码单元格。
- 参数:
code (str) – 单元格内容
- sphinx_gallery.notebook.add_markdown_cell(work_notebook, markdown)[source]#
向笔记本添加 Markdown 单元格。
- 参数:
markdown (str) – Markdown 单元格内容。
- sphinx_gallery.notebook.convert_code_to_md(text)[source]#
将代码块重写为使用 Markdown 首选的反引号表示法。
反引号表示法保留语法高亮。
- 参数:
text (str) – 大部分已转换的 Markdown 文本字符串。可能包含零、一或多个代码块，以代码块格式表示。
- sphinx_gallery.notebook.fill_notebook(work_notebook, script_blocks, gallery_conf, target_dir)[source]#
写入 Jupyter 笔记本单元格。
如果可用，则使用 pypandoc 将 rst 转换为 markdown。
- 参数:
script_blocks (list) – 每个列表元素应为 (标签、内容、行号) 的元组。
- sphinx_gallery.notebook.generate_image_src(image_path, gallery_conf, target_dir)[source]#
根据“notebook_images”配置修改笔记本的图片路径。
URL 保持不变。如果“notebook_images”配置是字符串，则它用作图片路径的前缀，相对于“src_dir”。如果“notebook_images”是 True，则图片嵌入为 URI。如果“notebook_images”是 False，则会添加“file://”。
- sphinx_gallery.notebook.jupyter_notebook(script_blocks, gallery_conf, target_dir)[source]#
逐个单元格生成 Jupyter 笔记本文件。
- sphinx_gallery.notebook.promote_jupyter_cell_magic(work_notebook, markdown)[source]#
将文本块中的 Jupyter 单元格魔法提升为笔记本中的代码块。
解析一段 Markdown 文本，查找以 Jupyter 单元格魔法开头的代码块（例如 %%bash）。每当找到一个时，它会将之前的文本和代码（作为可运行代码块）添加到 work_notebook 中。任何剩余的文本都会被返回。
- 参数:
markdown (str) – Markdown 单元格内容。
- sphinx_gallery.notebook.python_to_jupyter_cli(args=None, namespace=None, sphinx_gallery_conf=None)[source]#
将 Jupyter 笔记本渲染器公开到命令行。
接受与 ArgumentParser.parse_args 相同的参数。 sphinx_gallery_conf 的功能与 conf.py 中的相同。