Sphinx-Gallery ユーティリティ#
Python スクリプトを Jupyter ノートブックに変換#
Sphinx Gallery で利用可能な Python ソースを Jupyter ノートブックのコンバーターで実行スクリプトとして公開しています。このユーティリティを使用するには、単にスクリプトを呼び出して Python ソースファイルを指定します
$ python -m sphinx_gallery_py2jupyter python_script.py
Sphinx-Gallery をドキュメントスクリプtext拡張に埋め込む#
依存関係として使用するのではなく、プロジェクトに Sphinx-Gallery を埋め込みたい場合は、Sphinx 拡張フォルダー内で埋め込みスクリプトを呼び出すことができます
# Script to do a local install of sphinx-gallery
rm -rf tmp sphinx_gallery
easy_install -Zeab tmp sphinx-gallery
cp -vru tmp/sphinx-gallery/sphinx_gallery/ .
echo "Remember to add sphinx_gallery to your version control"
echo "Use in case of git:"
echo "$ git add sphinx_gallery"
この操作で、PyPI から最新のリリースコードがダウンロードされ、現在のフォルダーに保存されます。これは Sphinx-Gallery モジュールを簡略化したバージョンで、プロジェクトに組み込むことができます。バージョン管理システムにも追加する必要があります。
Minigallery ディレクティブ#
Sphinx-Gallery では minigallery ディレクティブが提供されているため、ギャラリーの縮小バージョンをドキュメントに追加できます。詳しくは、ミニギャラリーを追加する を参照してください。