Sphinx-Gallery API 参考

注意

Sphinx-Gallery 通常是通过 Sphinx 执行和配置变量间接使用，有关如何执行此操作，请参阅 配置。但是，作为标准 Python 项目，我们也在下面记录了许多函数和类，即使最终用户通常不需要这些函数和类。

Sphinx Gallery

sphinx_gallery:

gen_gallery	Sphinx-Gallery 生成器。
backreferences	反向引用生成器。
gen_rst	reST 文件生成器。
scrapers	用于嵌入图像的抓取器。
py_source_parser	Python 源文件解析器。
block_parser	BlockParser 将非 .py 源文件分成代码块和标记文本。
docs_resolv	链接解析器对象。
notebook	Jupyter 笔记本解析器。
downloads	可下载项目的实用程序。
sorting	Sphinx-Gallery（子）部分的排序器。
interactive_example	Binder 和 Jupyterlite 实用程序函数。
directives	自定义 Sphinx 指令。

实用程序。

其他实用程序。

sphinx_gallery.utils:

optipng(fname[, args])

就地优化 PNG。