sphinx_gallery.gen_rst#
reST 文件生成器。
通过遍历 Python 示例文件来生成示例的 rst 文件。
生成图像的文件应以“plot”开头。
函数#
- sphinx_gallery.gen_rst.codestr2rst(codestr, lang='python', lineno=None)[source]#
从代码字符串返回 reStructuredText 代码块。
- sphinx_gallery.gen_rst.execute_code_block(compiler, block, example_globals, script_vars, gallery_conf, file_conf)[source]#
执行示例文件的代码块。
- 参数：
compiler (codeop.Compile) – 用于编译代码块 AST 的编译器。
block (sphinx_gallery.py_source_parser.Block) – 要执行的代码块。
example_globals (Dict[str, Any]) – 示例的全局变量。
script_vars (Dict[str, Any]) – 配置和运行时变量。
gallery_conf (Dict[str, Any]) – 画廊配置。
file_conf (Dict[str, Any]) – 在源文件注释中给出的特定于文件设置，如下所示：
# sphinx_gallery_<name> = <value>。
- 返回值：
code_output – 在 reST 中执行代码的输出。
- 返回类型：
- sphinx_gallery.gen_rst.execute_script(script_blocks, script_vars, gallery_conf, file_conf)[source]#
执行并捕获来自已处于块结构中的 Python 脚本的输出。
- 参数：
- 返回值：
output_blocks (list) – 字符串列表，其中每个元素都是每个块输出的 reStructuredText 表示形式
time_elapsed (float) – 执行期间经过的时间
- sphinx_gallery.gen_rst.generate_dir_rst(src_dir, target_dir, gallery_conf, seen_backrefs, is_subsection=True)[source]#
为示例目录生成画廊 reStructuredText。
- 参数：
- 返回值：
index_path (str or None) – src_dir 的索引 rst 文件的路径。如果用户提供了自己的索引，则为 None。
index_content (str or None) – 画廊标题内容。当用户提供了自己的 index.rst 时为 None。
costs (List[Dict]) –
- 构建画廊每个元素的成本字典列表
键为“t”、“mem”、“src_file”和“target_dir”。
toctree_items (list,) – 我们为其生成了 ReST 的示例文件名列表。
- sphinx_gallery.gen_rst.generate_file_rst(fname, target_dir, src_dir, gallery_conf)[source]#
为给定示例生成 rst 文件。
- 参数：
- 返回值：
intro (str) – 示例的介绍。
title (str) – 示例标题。
cost (tuple) – 包含运行脚本所需的
(time_elapsed, memory_used)的元组。out_vars (dict) – 用于运行脚本的变量，可能包含条目
- ”stale”
如果示例已过时，则为 True。
- ”backrefs”
反向引用。
- ”passing”
如果示例通过，则为 True。
- ”formatted_exception”
异常的格式化字符串。
- sphinx_gallery.gen_rst.handle_exception(exc_info, src_file, script_vars, gallery_conf)[source]#
修剪和格式化异常，可能引发错误等。
- sphinx_gallery.gen_rst.md5sum_is_current(src_file, mode='b')[source]#
检查 src_file 的 MD5 哈希值是否与磁盘上的哈希值相同。
- sphinx_gallery.gen_rst.rst_blocks(script_blocks, output_blocks, file_conf, gallery_conf, *, language='python')[source]#
生成包含脚本散文、代码和输出的 rst 字符串。
- 参数：
script_blocks (list) – (标签、内容、行号) 列表，其中每个元素都是一个元组，包含标签（“text”或“code”）、块的对应内容字符串和前导行号
output_blocks (list) – 字符串列表，每个元素是每个代码块输出的重构文本表示
file_conf (dict) – 在源文件注释中给出的特定于文件设置，如下所示：
# sphinx_gallery_<name> = <value>language (str) – 用于代码块语法高亮的语言。必须是 Pygments 识别的名称或别名。
gallery_conf (dict) – 包含 Sphinx-Gallery 的配置
- 返回值：
out – rst 笔记本
- 返回类型：
- sphinx_gallery.gen_rst.save_rst_example(example_rst, example_file, time_elapsed, memory_used, gallery_conf, *, language='python')[source]#
将 rst 笔记本保存到 example_file，包括标题和页脚。