Sphinx-Gallery API リファレンス#

注意

通常 Sphinx-Gallery は、Sphinx 実行および設定変数によって間接的に使用されます。そのため、使用方法は設定で確認できます。ただし、標準の Python プロジェクトとして、通常エンドユーザーには必要ないとしても、さまざまな関数はクラスに以下に記載しています。

Sphinx ギャラリー#

`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 ディレクティブ

Utilities.

その他ユーティリティ

optipng(fname[, args])

PNG を最適化して配置します。