Sphinx-Gallery

Sphinx 拡張機能で、Python スクリプトのセットからサンプルの HTML ギャラリーを構築します。使用法などの概要については ドキュメント をご覧ください。

機能

• 🚀 サンプルギャラリーを作成する 出力や図をキャプチャしつつ Python サンプルスクリプトを純粋に実行し、Sphinx によってドキュメントに構築される reST ファイルにそれらを描画します。

• 📝 例示の Python ファイルに reST を埋め込む、ドキュメントでプロットを生成するコードと、ナレーションのようなコンテンツを織り交ぜることができます。Sphinx-Gallery は、サンプルページごとに自動的に Jupyter Notebook を生成します。

• 📋 API ドキュメントにミニギャラリーを追加する Sphinx-Gallery は、特定の関数/メソッド/などを利用するサンプルをすべてリストするミニギャラリーを生成できます。

• 🔗 例にインタースフィンクスリンクを追加する Sphinx-Gallery は、例で使用される関数/メソッド/クラスの API ドキュメントに自動的にリンクを追加できます (インタースフィンクスを使う Python モジュールの場合は)。

• 🗒️ 複数のギャラリーを管理する 複数のサンプルフォルダのギャラリーを作成して埋め込みます。

インストール

pip で直接インストールするには次のコマンドを使用します。

$ pip install sphinx-gallery

ヒント

Sphinx-Gallery は Matplotlib や Matplotlib ベースのパッケージ (Seaborn など) から画像をスクレイピングすることもサポートしています。生成される PNG ファイルのサイズを小さくするには、システムのバイナリ optipng をインストールすることをお勧めします。

引用方法

Sphinx-Gallery を引用する場合は、Zenodo デポジトリ を利用できます。

コントリビューション

関心をお寄せいただき、ありがとうございます。はじめに

コントリビューションガイド をご覧ください。