Sphinx-Gallery API 參考

注意

Sphinx-Gallery 通常是透過 Sphinx 執行和組態變數間接使用，請參閱組態 了解如何操作。 然而，作為一個標準的 Python 專案，我們也在下方記錄了許多函式和類別，即使這些通常不需要終端使用者使用。

Sphinx Gallery

sphinx_gallery:

gen_gallery	Sphinx-Gallery 產生器。
backreferences	反向參考產生器。
gen_rst	reST 檔案產生器。
scrapers	用於嵌入圖片的 Scrapers。
py_source_parser	用於 Python 原始碼檔案的解析器。
block_parser	BlockParser 將非 .py 原始碼檔案分割成程式碼區塊和標記文字。
docs_resolv	連結解析器物件。
notebook	用於 Jupyter Notebook 的解析器。
downloads	用於可下載項目的工具。
sorting	用於 Sphinx-Gallery (子)章節的排序器。
interactive_example	Binder 和 Jupyterlite 工具函式。
directives	自訂 Sphinx 指令。

工具。

雜項工具。

sphinx_gallery.utils:

optipng(fname[, args])

就地最佳化 PNG。