変更履歴#

v0.18.0#

実装された機能拡張

  • 計算時間の書き込みを無効にする機能を追加 #1385 (bmwiedemann)

  • [ENH] 同じセルからの複数の画像を単一画像としてレンダリングするオプションを追加 #1384 (tsbinns)

修正されたバグ

  • 独自のインデックスギャラリーが最初の場合、indexst 変数が存在しない問題を修正 #1383 (lucyleeow)

プロジェクトメンテナンス

v0.17.1#

修正されたバグ

  • 修正: 保存されたコンパイル済み正規表現の安定性を修正 #1369 (larsoner)

  • ENH: _sanitize_rst を改善 #1366 (timhoffm)

  • バックリファレンスを見つける際に prefer_full_module 設定に従う #1364 (QuLogic)

  • prefer_full_module を使用したクラス属性へのリンクを修正 #1363 (QuLogic)

  • ミニギャラリーディレクティブのパス入力解決を改善 #1360 (lucyleeow)

  • 修正: バックリファレンスが無効の場合、str パスのミニギャラリーエントリを許可 #1355 (lucyleeow)

  • 修正: ユーザーが渡したインデックスがある場合にzipファイルを生成 #1353 (lucyleeow)

ドキュメント

  • DOC joblibの警告に関するドキュメントを改善 #1367 (lucyleeow)

  • DOC joblib の警告をフィルタリングする際の注意点を追加 #1362 (lucyleeow)

  • DOC ミニギャラリーディレクティブのドキュメントを少し更新 #1358 (lucyleeow)

プロジェクトメンテナンス

v0.17.0#

このリリースでは、Python 3.8 および Sphinx 4 のサポートが終了しました。要件は Python >= 3.9 および Sphinx >= 5 になりました。

実装された機能拡張

  • 紹介ツールチップが最初の段落に対応 #1344 (fgmacedo)

  • 修正: CircleCIアーティファクトのJupyterlite #1336 (lesteve)

  • MNT: README.rst を GALLERY_HEADER.rst にリネーム #1321 (timhoffm)

  • [ENH] 失敗した例のカスタムサムネイルを追加 #1313 (tsbinns)

  • ENH ダウンロード/ランチャーリンクを pydata-sphinx-theme セカンダリサイドバーに統合 #1312 (Charlie-XIAO)

  • zipダウンロードのオプションを追加 #1299 (jamiecook)

  • ギャラリー設定からアニメーション形式を設定できるようにする #1243 (QuLogic)

修正されたバグ

  • マルチモジュール intersphinx レジストリの処理を修正 #1320 (QuLogic)

  • BUG: SyntaxError のトレースバックに関するバグを修正 #1301 (larsoner)

ドキュメント

プロジェクトメンテナンス

v0.16.0#

Sphinx 7.3.0以降では、キャッシュとシリアライズのチェックが変更されました。 sphinx_gallery_conf で、ResetArgv() のようなインスタンス化されたクラス、FileNameSortKey のようなクラス、または notebook_modification_function のような呼び出し可能なものを渡す代わりに、クラスまたは呼び出し可能なものへの完全修飾名文字列を渡す必要があります。名前文字列を使用するように変更すると、安定した__repr__を確保するためのクラスの使用は冗長になるため、単に関数を使用できます。

詳細については、呼び出し可能オブジェクトのインポートを参照してください。

実装された機能拡張

  • ENH: subsection_orderとしてプレーンリストを許可し、ワイルドカードをサポート #1295 (timhoffm)

  • [ENH] Minigalleryは任意のファイル/グロブパターンを入力として受け取ることができる #1226 (story645)

修正されたバグ

ドキュメント

  • DOC アニメーションドキュメントのFFMpegノートを更新 #1292 (lucyleeow)

  • readme: クイックスタートセクションを追加 #1291 (Borda)

  • readme: ドキュメントへのリンクを追加 #1288 (Borda)

  • DOC サブレベルのサンプルギャラリーを明確化 #1281 (lucyleeow)

  • DOC advanced.rst のスクレーパーセクションで image_srcset 設定について言及 #1280 (lucyleeow)

  • BUG: ignore_repr_typesとreset_argvのサンプル使用例のエラーを修正 #1275 (speth)

  • DOC ドキュメントに ‘nested_sections’ True を使用 #1263 (lucyleeow)

  • fix: ダウンロードメッセージのピリオド抜けを修正 #1255 (AlejandroFernandezLuces)

  • 「利用している人」にHyperSpyとkikuchipyを追加 #1247 (jlaehne)

  • DOC: contribute.rst のフォーマットを修正 #1237 (StefRe)

プロジェクトメンテナンス

v0.15.0#

このリリースでPython 3.7のサポートが終了しました。要件はPython >=3.8になりました。Pillowが依存関係として追加されました。

実装された機能拡張

  • ENH: エラーとファイル名のログの可視性を向上 #1225 (larsoner)

  • ENH: API使用状況グラフを改善 #1203 (larsoner)

  • ENH: sg_execution_timesを常に書き込み、DataTableを作成 #1198 (larsoner)

  • ENH: すべての計算時間を書き込み #1197 (larsoner)

  • ENH: あらゆる言語のソースファイルをサポート #1192 (speth)

  • FEA 例のレコメンダーシステムを追加 #1125 (ArturoAmorQ)

修正されたバグ

  • FIX JupyterLiteの内容を早期にコピーして、jupyterlite_sphinx build-finished の前に実行されるようにする #1213 (lesteve)

  • BUG: 孤立したsg_api_usageのバグを修正 #1207 (larsoner)

  • MAINT ミスマッチな「ignore」ブロックのチェックを修正 #1193 (speth)

  • バックレフで新しいモジュールをインポートしない #1177 (aganders3)

ドキュメント

  • DOC 設定リストを見出しの下に配置 #1230 (lucyleeow)

  • DOC: 貢献ガイド #1223 (story645)

  • DOC リリースノートでpython 3.7のサポートが終了したことに言及 #1199 (lucyleeow)

プロジェクトメンテナンス

v0.14.0#

実装された機能拡張

  • MAINT: バックリファレンスのドキュメントを更新し、テストを追加 #1154 (lucyleeow)

  • 実行時間レポートから余分なスペースを削除 #1147 (stefanv)

修正されたバグ

  • MAINT: Sphinx 7.2 に対応 #1176 (larsoner)

  • mpl gui の警告キャッチャーを新しいエラーメッセージに更新 #1160 (story645)

  • md5sum 生成の一貫したエンコーディングを保証 #1159 (sdhiscocks)

  • Maint: Sphinx が pathlib を使用するようになったため、app.builder.outdir を修正 #1155 (lucyleeow)

  • _LoggingTee を TextIO と互換性を持たせる #1151 (o-laurent)

  • MAINT: build_sphinx を sphinx-build に置き換え #1139 (oscargus)

  • CSS ファイルで table.dataframe の幅を auto に設定 #1128 #1137 (photoniker)

ドキュメント

  • DOC: _get_docstring_and_rest のドキュメント文字列のタイプミスを修正 #1182 (lucyleeow)

  • DOC: configuration.rst の Jupyterlite 設定例を修正 #1181 (lucyleeow)

  • DOC: 基本ギャラリーの名前を更新 #1153 (lucyleeow)

  • DOC: sphinxcontrib-svg2pdfconverter へのリンクを追加 #1145 (oscargus)

  • MNT: バッジをいくつか追加 #1143 (oscargus)

  • MAINT: Zenodo の参照を修正 #1140 (oscargus)

  • 「誰が使っているか」リストに OpenTURNS を追加 #1133 (jschueller)

  • ダウンロードボタンを正しく非表示にする #1131 (timhoffm)

プロジェクトメンテナンス

  • MAINT: PR に適切なラベルが付けられるように強制 #1183 (larsoner)

  • MAINT: クラスプロパティをテストするように test_identify_names に追加 #1180 (lucyleeow)

  • MAINT: Lint - ドキュメント文字列の AST ノードタイプを修正 #1179 (lucyleeow)

  • MAINT: figure_rst パスのテストを独自のユニットテストに移動 #1173 (lucyleeow)

  • MAINT: test_figure_rst_srcset で未使用の parametrize を削除 #1172 (lucyleeow)

  • MAINT: ノートブックの最初/最後のセルテストをパラメーター化 #1171 (lucyleeow)

  • MAINT: Lint API の使用状況 #1170 (lucyleeow)

  • MAINT: Lint を修正し、ドキュメント文字列をクリーンアップおよび拡張 #1169 (lucyleeow)

  • [pre-commit.ci] pre-commit autoupdate #1167 (pre-commit-ci[bot])

  • MAINT: yamllint #1166 (larsoner)

  • ENH: pre-commit を使用 #1165 (larsoner)

  • MAINT: black . #1164 (larsoner)

  • MAINT: 古くなったチェックを改善 #1161 (larsoner)

  • url の _embed_code_links に pathlib を使用 #1157 (lucyleeow)

  • MAINT: conda の解決を高速化 #1156 (larsoner)

  • MNT: % フォーマットを f-strings に変更 #1135 (StefRe)

  • MAINT: 依存関係と intersphinx リンクを更新 #1132 (larsoner)

v0.13.0#

実装された機能拡張

  • ENH: デフォルトロールのバックリファレンスを作成 #1122 (StefRe)

  • ENH: 不明なキーで check_jupyterlite_conf でエラーを発生させる #1119 (lesteve)

  • ENH: コンテンツに基づいて Jupyterlite ノートブックを変更する機能を追加 #1113 (lesteve)

  • ENH: WebP のサポートを追加 #1111 (StefRe)

修正されたバグ

  • ENH: sphinx_gallery_conf の早期初期化によるコードのクリーンアップ #1120 (lesteve)

  • FIX: JupyterLite ボタンのリンク #1115 (lesteve)

  • サムネイルテキストのフォーマットを修正 #1108 (StefRe)

  • ネストされたギャラリーフォルダーで JupyterLite URL を修正 #1105 (lesteve)

  • スクレイピング時に matplotlib バックエンドが変更される可能性を回避 #1102 (ayshih)

  • デフォルトの '%matplotlib inline' 行を削除 #1099 (ArturoAmorQ)

  • FIX: 非 HTML 出力のみを ANSI サニタイズ #1097 (sdhiscocks)

  • BUG: show_api_usage のバグを修正 #1095 (larsoner)

  • FIX: 目次ブロックの最後に空行を追加 #1094 (sdhiscocks)

API の変更

  • API: 非推奨の mayavi サポートを削除 #1090 (larsoner)

ドキュメント

  • qtgallery (Qt スクレイパー) への参照を追加 #1126 (aganders3)

  • DOC: reStructuredText の略語を統一 #1118 (StefRe)

  • PyGMT を「Sphinx-Gallery を利用しているプロジェクト」リストに追加 #1114 (yvonnefroehlich)

  • DOC: JupyterLite 0.1.0b19 リリース後の JupyterLite ドキュメントを更新 #1106 (lesteve)

  • プロジェクトリストを修正 #1101 (StefRe)

  • DOC: 変更点をドキュメント化 #1098 (larsoner)

  • DOC: ポイントリリースにおける変更点をドキュメント化 #1096 (larsoner)

プロジェクトメンテナンス

  • MAINT: エイリアス化されていない status_iterator を使用 #1124 (larsoner)

  • CLN: 初期設定検証の名前を整理 #1123 (lesteve)

  • MNT: Python 2 の残骸を削除 #1116 (StefRe)

  • MNT: 最小 Sphinx バージョンを README.rst と同期 #1110 (StefRe)

  • CI: jupyterlite-pyodide-kernel を CI にインストール #1107 (lesteve)

  • 非 agg Matplotlib バックエンドを設定するテストを追加 #1104 (ayshih)

  • MAINT: バージョンを dev に更新 #1089 (larsoner)

v0.12.2#

修正されたバグ

v0.12.1#

修正されたバグ

v0.12.0#

このリリースで、Sphinx < 4 のサポートが廃止されました。Sphinx >= 4 が必須となりました。

実装された機能拡張

  • ENH: rst ファイルのパススルーを許可 #1071 (jklymak)

  • 高度な使用例を更新 #1045 (HealthyPear)

  • サンプルページヘッダーに説明的なリンクテキストを使用 #1040 (betatim)

  • python_to_jupyter_cli で sphinx_gallery_conf を公開 #1027 (OverLordGoldDragon)

  • DOC: 「Sphinx-Gallery を利用しているプロジェクト」リストを修正 #1015 (StefRe)

  • [MAINT, MRG] API 使用に関するいくつかの小さな残存物 #997 (alexrockhill)

  • [ENH, MRG] 未使用の API エントリを孤立化 #983 (alexrockhill)

  • Jupyterlite の統合 #977 (amueller)

修正されたバグ

ドキュメント

  • DOC: html-noplot で設定警告を抑制するためのメモを追加 #1084 (rossbar)

  • ミニギャラリーのドキュメントで段落を並び替え #1048 (ayshih)

  • DOC: pydata-sphinx-theme に切り替え #1013 (larsoner)

  • CHANGES 内の Sphinx リンクのタイプミスを修正 #996 (alexisthual)

プロジェクトメンテナンス

v0.11.1#

このリリースで、Sphinx < 3 のサポートが廃止されました。Sphinx >= 3 が必須となりました。

修正されたバグ

  • BUG: シングルコラムのサンプルを修正 #993 (larsoner)

実装された機能拡張

  • テストで Mock をより多く使用 #986 (QuLogic)

  • 古い Sphinx 互換コードを削除 #985 (QuLogic)

v0.11.0#

このバージョンでは、コード出力に適用される「Out:」プレフィックスが、追加の実際のテキストではなく、CSS 疑似要素から作成されるようになりました。詳細については、#896 を参照してください。

実装された機能拡張

ギャラリーセクションのネスト化（つまり、ギャラリーサブフォルダ）が #904 で実装されました。この機能は、前の動作が望ましい場合、無効にできます（ドキュメントの config オプション nested_sections を参照）(alexisthual)

ツールチップがギャラリーアイテムの上にオーバーレイされるようになりました commit 36166cd。カスタム CSS の調整が必要になる場合があります (alexisthual)。

  • サブギャラリーのセクションおよびサンプルタイトルのレベルの問題 #935

  • ネストされた index.rst を記述する機能を追加 #855

  • バックリファレンス時に module_short の代わりに module をオプションで使用可能 #950 (ExtremOPS)

  • ENH: より良いダークモードのサポート #948 (larsoner)

  • API リファレンスサンプルのサムネイルを共通の div に保存 #946 (alexisthual)

  • Python ソースパーサーでコードブロックを無視するフラグを追加 #941 (guberti)

  • Jupyter Notebook コンバーターのコードブロックの処理を改善 #940 (guberti)

  • [MRG] ネストされたセクションに関する変更ログ #926 (alexisthual)

  • 暗黙のバックリファレンスを除外する可能性 #908 (StefRe)

  • [MRG] ネストされた構造の処理 #904 (alexisthual)

  • 疑似要素を 'Out:' のプレフィックスに使用 #896 (QuLogic)

  • 修正: 最新の pytest に対応 #894 (larsoner)

  • ファイル単位で capture_repr を設定可能に #891 (StefRe)

修正されたバグ

ギャラリーアイテムの表示に float プロパティではなく CSS グリッドを使用するようになりました #906、サムネイル用のカスタム CSS を適応させるための 移行ガイド を参照してください (alexisthual)

ドキュメントの更新

  • Sphinx-gallery を使用しているプロジェクトに RADIS を追加 #979 (erwanp)

  • sphinx-gallery ユーザーのリストに Tonic を追加 #972 (biphasic)

  • ユーザープロジェクトリストに Apache TVM を追加 #942 (guberti)

  • DOC: changelog の rst リンク構文を修正 #925 (GaelVaroquaux)

  • PyPi 用の GitHub URL を追加 #923 (andriyor)

  • ユーザープロジェクトのリストに Biotite を追加 #919 (padix-key)

  • MAINT: LooseVersion を削除 #916 (larsoner)

  • DOC 「スクリプト内の関数名を特定する」の例を修正 #903 (StefRe)

  • DOC API ドキュメントのミニギャラリー追加に関するドキュメントを更新 #899 (StefRe)

  • PyVista の例を追加！ #888 (banesullivan)

  • プロジェクトリスト内のいくつかのリンクを修正 #883 (ixjlyons)

v0.10.1#

このリリースでは、Python 3.6 のサポートが終了しました。要件は Python >=3.7 です。

実装された機能拡張

  • 機能リクエスト: 各例またはすべての例の後に reset_modules を適用する #866

  • reset_modules を例の前または後、あるいは両方で実行できるようにする #870 (MatthewFlamm)

修正されたバグ

  • embed_code_links が <exception: list indices must be integers or slices, not str> をスローする #879

  • 0.10.0 が sphinx_gallery.load_style を壊す #878

  • load style に imagesg ディレクティブを追加 #880 (lucyleeow)

  • sphinx_gallery_conf の 'plot_gallery' にブール値を使用 #863 (timhoffm)

マージされたプルリクエスト

v0.10.0#

このバージョンでは、デフォルトの Sphinx-Gallery .css ファイルが更新され、名前の先頭に 'sg_' が付くようになりました。詳細については、#845 を参照してください。

実装された機能拡張

  • 画像以外のものにも image_scrapers 機能を利用できるように一般化 #833

  • rst 警告のみで失敗し、例を実行しないモードを追加 #751

  • 簡単に始められるように「テンプレート」を追加 #555

  • ENH 画像の欠落警告を防ぐためにダミー画像を生成する設定を追加 #828 (lucyleeow)

  • ENH: matplotlib_scraper とディレクティブに hidpi オプションを追加 #808 (jklymak)

修正されたバグ

  • BUG Binder URL でブランチ名とファイルパスを URL エンコード #844 (sdhiscocks)

  • 生成された reST から ANSI 文字をサニタイズ: HTML 出力から ANSI 文字 を削除 #838 (agramfort)

  • Bug Python nightly で markupsafe バージョンをピン留め #831 (lucyleeow)

  • BUG Windows で test_minigallery_directive が失敗する問題を修正 #830 (lucyleeow)

  • BUG CI で LaTeX エラー: File `tgtermes.sty' not found を修正 #829 (lucyleeow)

マージされたプルリクエスト

  • DOC reset_modules のドキュメントを更新 #861 (lucyleeow)

  • 末尾の空白を削除 #859 (lucyleeow)

  • アニメーションサポートを有効にするための情報を例に追加 #858 (dstansby)

  • CSSファイル名を更新、ドキュメントを修正 #857 (lucyleeow)

  • MAINT: mayaviビルドのCircleCIでのハングを修正 #850 (lucyleeow)

  • MAINT: mayaviビルドのAzure CIでのハングを修正 #848 (lucyleeow)

  • gen_rst.pyのexecute_code_blockをリファクタリング #842 (lucyleeow)

  • [Maint] Travisを削除 #840 (agramfort)

  • DOC サポートされている画像拡張子にGIFを追加 #836 (lucyleeow)

  • DOC image_scrapersドキュメントの明確化と修正 #834 (jnothman)

  • DOC readme.rstのプロジェクトリストを更新 #826 (lucyleeow)

  • DOC Zenodoバッジのリンクを修正 #825 (lucyleeow)

  • DOC ユーザーリストにTorchIOを追加 #824 (fepegar)

v0.9.0#

このリリースでPython 3.5のサポートが終了しました。要件はPython >=3.6です。

実装された機能拡張

  • 失敗した場合に例を「スキップ」するモードを追加 #789

  • sphinx_gallery_thumbnail_numberは負のインデックスをサポートできますか？ #785

  • サムネイルスタイルを設定 #780

  • ENH: 無効なsphinx_gallery_confキーのチェック #774

  • DOC ダウンロードリンクの注釈を非表示にする方法を文書化 #760

  • DOC projects_list.rstでintersphinx参照を使用 #755

  • 出力キャプチャを後続のコードブロックまで遅延させる #363

  • ENH: 表示するものがなければミニギャラリーのみを追加 #813 (NicolasHug)

  • 図のスクレイピングを次のコードブロックに延期するオプションフラグ #801 (ayshih)

  • ENH: PyQt5 #794 (larsoner)

  • エラー時に失敗ではなく警告する設定を追加 #792 (Cadair)

  • sphinx_gallery_thumbnail_numberが負のインデックスをサポートできるようにする #786 (seisman)

  • 画像をサムネイルにリサイズする際に導入される境界線を透明にする #781 (rossbar)

  • MAINT: Travis CIジョブをAzureに移動 #779 (lucyleeow)

  • ENH, DEP: 無効なキーのチェック、古いキーの削除 #775 (larsoner)

修正されたバグ

  • タイトルターゲット上のスペース用のカスタムCSSがpydata-sphinx-themeと競合 #815

  • 例がないオブジェクトに対してもミニギャラリーが生成される #812

  • collections.abcからのJinja2のインポートが原因でPythonナイトリーが失敗 #790

  • test_rebuildとtest_error_messagesがtravisで失敗 #777

  • アニメーションがRead the Docsで表示されない #772

  • BUG: 空のコードブロック出力 #765

  • BUG: CSSセレクタを修正 #816 (larsoner)

  • MAINT: リンクのテストを修正 #811 (larsoner)

  • SVGデフォルトサムネイルサポートを修正 #810 (jacobolofsson)

  • カスタムgallery_dirsのクリーンなドキュメントを明確化 #798 (timhoffm)

  • MAINT Azure PythonナイトリーでJinja2バージョンを指定 #793 (lucyleeow)

  • BUG 最後のブロックが空の場合に削除 #791 (lucyleeow)

  • READMEのTravis CIバッジをAzureバッジに置き換え #783 (sdhiscocks)

  • 最新のreドキュメントを指す #778 (dstansby)

マージされたプルリクエスト

  • DOC CSS変更に関するセクションを追加 #820 (lucyleeow)

  • DOC projects_list.rstでintersphinx参照を使用 #819 (lucyleeow)

  • DOC CIバッジを更新 #818 (lucyleeow)

  • DOC MakefileにSOURCEDIRを含める #814 (NicolasHug)

  • DOC: sphinx-galleryを使用している2つのプロジェクトを追加 #807 (mfeurer)

  • DOC: 例の参照に関する高度なドキュメントを明確化 #806 (mfeurer)

  • MAINT: リンクを追加 #800 (larsoner)

  • 「Optunaを使用している人」にOptunaを追加 #796 (crcrpar)

  • DOC CSSスタイルに関するセグメントを追加 #788 (lucyleeow)

  • DOC ドキュメントの軽微なタイプミスを修正 #787 (lucyleeow)

  • DOC index.rstのCIリンクを更新 #784 (lucyleeow)

v0.8.2#

readthedocsでHTMLアニメーションをレンダリングできるようにします。

実装された機能拡張

  • DOC sphinx_gallery_thumbnail_pathについて詳しく説明 #764 (lucyleeow)

  • ENH: run_stale_examples config変数を追加 #759 (larsoner)

  • 例のヘッダーの注釈を無効にするオプション #757

  • show_signatureオプションを追加 #756 (jschueller)

  • ENH: JupyterのようにHTML出力をスタイル設定 #752 (larsoner)

  • ENH: reSTコメントを追加、読み取り専用 #750 (larsoner)

  • 生成されたrstファイルに関する警告とエラーを元のPythonファイルに関連付け/生成されたファイルの誤った書き込みを防止 #725

修正されたバグ

  • 例のギャラリーがダウンしている #753

  • DOC configuration.rstのrun_stale_examplesコマンドを修正 #763 (lucyleeow)

  • DOC projects_listのリンクを更新 #754 (lucyleeow)

  • readthedocsでHTMLアニメーションをレンダリングできるようにする #748 (sdhiscocks)

マージされたプルリクエスト

v0.8.1#

WindowsパスのBinderロゴ画像ファイルを修正。

修正されたバグ

  • sphinx_gallery/tests/test_full.py::test_binder_logo_existsが失敗 (パスが明らかに間違っている) #746

  • BUG _static BinderロゴのWindows相対パスエラー #744

  • BUG Windowsドライブ相対パスエラーを回避するためにBinderロゴをコピー #745 (lucyleeow)

マージされたプルリクエスト

  • ドキュメント: 相互参照の例へのリンクを追加 #743 (lucyleeow)

v0.8.0#

設定 thumbnail_size のデフォルト値は、バージョン0.9.0で (400, 280) (CSSで指定された最大サイズの2.5倍) から (320, 224) (CSSで指定された最大サイズの2倍) に変更されます。

実装された機能拡張

  • コマンドライン引数を例に渡す #731

  • ノートブックでのrstからmdへのサポートを制限 #219

  • 新しいmatplotlibのアニメーションでffmpegを有効にする #733 (dopplershift)

  • コマンドライン引数を例のスクリプトに渡すオプションを実装 #732 (mschmidt87)

  • 機能強化: 入力を許可しない #729 (larsoner)

  • ノートブックの画像リンクとデータURIのサポートを追加 #724 (sdhiscocks)

  • reSTからMDへの見出しをサポート #723 (sdhiscocks)

  • 機能強化: ipynb用にrstをmdに変換するためのpypandocをサポート #705 (lucyleeow)

  • 機能強化: Animationのより広い定義を使用 #693 (larsoner)

修正されたバグ

  • _repr_html_がRTDに表示されない #736

  • Binderアイコンがハードコードされているため、一部のブラウザで読み込みエラーが発生する #735

  • 例のスクリプトを実行せずに画像をスクレイピングする方法 #728

  • sphinx-gallery/0.7.0: ドキュメントをビルドする際、TypeError: ‘str’ object is not callableが発生する #727

  • サムネイルのオーバーサンプリング #717

  • 事前にビルドされたギャラリーの操作 #704

  • “plt.show()”を呼び出すと、見苦しい警告が発生する #694

  • ドキュメントv0.6.2 stableでの検索が機能しない #689

  • pypandocのロガーメッセージを修正 #741 (lucyleeow)

  • ローカルのbinderロゴsvgを使用 #738 (lucyleeow)

  • バグ: スクレイパーエラーの処理を修正 #737 (larsoner)

  • カスタムイメージスクレイパーの例に関するドキュメントを改善 #730 (mschmidt87)

  • プラットフォームの改行に依存しないmd5ハッシュを作成 #722 (sdhiscocks)

  • メンテナンス: mayaviを処理 #720 (larsoner)

  • ドキュメント: thumbnail_sizeを明確化し、デフォルトの変更について記述 #719 (lucyleeow)

  • バグ: 常にリンクを行う #714 (larsoner)

  • ドキュメント: オプションを正しく記述 #711 (larsoner)

  • バグ: ‘capture_repr’ と ‘ignore_repr_types’ をチェック #709 (lucyleeow)

  • ドキュメント: Sphinx URLを更新 #708 (lucyleeow)

  • バグ: zipダウンロードに相対パスを使用 #706 (pmeier)

  • 修正: masterを使用してnightlyビルド #703 (larsoner)

  • メンテナンス: CircleCIを修正 #701 (larsoner)

  • readthedocsでhtmlをレンダリングできるようにする #700 (sdhiscocks)

  • matplotlib aggの警告を削除 #696 (lucyleeow)

マージされたプルリクエスト

  • ドキュメント: エラー/警告の解釈に関するセクションを追加 #740 (lucyleeow)

  • ドキュメント: 引用の詳細をreadmeに追加 #739 (lucyleeow)

  • ギャラリー用のPlotlyの例 #718 (emmanuelle)

  • ドキュメント: アニメーションの例でmatplotlibを指定 #716 (lucyleeow)

  • メンテナンス: Travis実行でpytestのバージョンを上げる #712 (larsoner)

  • ドキュメント: configuration.rstの警告セクションを更新 #702 (lucyleeow)

  • ドキュメント: 他のビルダータイプの言及を削除 #698 (lucyleeow)

  • バージョンを上げる #692 (lucyleeow)

v0.7.0#

開発者の変更#

  • 組み込みのエラーではなく、Sphinxのエラーを使用します。

実装された機能拡張

  • 機能強化: Sphinxエラーを使用 #690 (larsoner)

  • 機能強化: FuncAnimationのサポートを追加 #687 (larsoner)

  • ミニギャラリーを挿入するためのSphinxディレクティブ #685 (ayshih)

  • ミニギャラリーを挿入するためのSphinxディレクティブを提供する #683

  • 機能強化: テンプレートmodule.rstに相互参照ラベルを追加 #680 (lucyleeow)

  • 機能強化: show_memory拡張APIを追加 #677 (larsoner)

  • GPUメモリログのサポート #671

  • 機能強化: サムネイルにalt属性を追加 #668 (lucyleeow)

  • 機能強化: インデックス内のサムネイルのalt属性をより情報豊富にする #664

  • 機能強化: 画像のalt属性をより情報豊富にする #663 (lucyleeow)

  • 機能強化: 要求された場合はoptipngを使用 #656 (larsoner)

  • サムネイルがギャラリーページを重くし、読み込み時間が長くなる #655

  • メンテナンス: エラーメッセージを改善 #600

  • 画像タグのより情報豊富な「alt」属性 #538

  • 機能強化: “examples using my_function”への簡単なリンク #496

  • サブギャラリーは個別の「gallery rst」ファイルで生成する必要がある #413

  • matplotlibアニメーションのサポート #150

修正されたバグ

  • module.rstのクラスにbackrefラベルを追加 #688 (lucyleeow)

  • チルダの使用を考慮するようにバックリファレンスの検査を修正 #684 (ayshih)

  • test_fullでnumpy RandomStateの正規表現を修正 #682 (lucyleeow)

  • html内のnumpyデータを検索するテストの正規表現を修正 #681

  • 修正: sys.stdoutのパッチ処理を修正 #678 (larsoner)

  • check-manifestがmasterを失敗させている #675

  • ロガーが別のセルで作成された場合、ロガーの出力がキャプチャされない #672

  • 修正: タイトルから改行を削除 #669 (larsoner)

  • バグ: Tinybuild autosummary リンクが Sphinx dev で失敗する #659

ドキュメント

  • ドキュメント: plot_0_sin.py のラベルを raw 文字列に更新 #674 (lucyleeow)

  • ドキュメント: Sphinx の URL を https に更新 #673 (lucyleeow)

  • ドキュメント: syntax.rst を明確化 #670 (lucyleeow)

  • ドキュメント: コード内のみでの設定コメント削除に関する注記を追加 #667 (lucyleeow)

  • ドキュメント: syntax.rst のリンクを更新 #666 (lucyleeow)

  • ドキュメント: タイプミスを修正、明確化 #662 (lucyleeow)

  • ドキュメント: html-noplot を更新 #658 (lucyleeow)

  • ドキュメント: PNGScraper の例を修正 #653 (denkii)

  • ドキュメント: ドキュメントファイルのタイプミスを修正 #652 (TomDonoghue)

  • sphinx-gallery の設定の適用と削除に関する不整合 #665

  • make html-noplot の手順が古くなっている #606

マージされたプルリクエスト

  • gen_gallery.py の lint を修正 #686 (lucyleeow)

  • タイトルに句読点がある場合のより良いサムネイル代替テスト #679 (lucyleeow)

  • check-manifest の変更に対するマニフェストを更新 #676 (lucyleeow)

  • メンテナンス: CircleCI を更新 #657 (larsoner)

  • バージョンを 0.7.0.dev0 に上げる #651 (lucyleeow)

v0.6.2#

  • v0.6.1 で CSS ファイルが欠落していたため、パッチリリース。マニフェストチェックを CI に追加。

実装された機能拡張

  • sphinx-gallery を引用する最適な方法 #639

  • MRG, ENH: Zenodo バッジを追加 #641 (larsoner)

修正されたバグ

  • バグ: pandas の intersphinx URL が間違っている #646

  • CSS が wheel に含まれていない？ #644

  • バグ: CSS の include を修正し、CI にマニフェストチェックを追加 #648 (larsoner)

  • pandas の intersphinx URL を更新 #647 (lucyleeow)

マージされたプルリクエスト

v0.6.1#

開発者向けの変更#

  • Zenodo 統合を追加。このリリースは Zenodo が取得するためのものです。

実装された機能拡張

  • pathlib.Path を backreferences_dir オプションに許可 #635

  • ENH: backrefences_dir が pathlib オブジェクトであることを許可 #638 (lucyleeow)

修正されたバグ

  • ギャラリーからドキュメントへのリンクを作成する際の TypeError #634

  • バグ: ファイル名にスペースがあるかを確認 #636 (lucyleeow)

  • エラーメッセージの欠落していたスペースを修正 #632 (anntzer)

  • バグ: サンプルファイル名のスペースが画像リンクを壊す #440

マージされたプルリクエスト

  • ドキュメント: リリースガイドへのマイナーアップデート #633 (lucyleeow)

  • リリースバージョンを上げる #631 (lucyleeow)

v0.6.0#

開発者向けの変更#

  • ハード依存関係の数を減らし、dev-requirements.txt を追加。

  • AppVeyor を Python 3.6 から 3.7 に上げる。

  • CSS を分割し、CSS をロードするサブ拡張機能を作成。

実装された機能拡張

  • ENH: 最後のセル設定を追加 #625 (lucyleeow)

  • ENH: ダウンロードリンクのサブクラスを追加 #623 (larsoner)

  • ENH: 新しいファイルベースの conf-parameter thumbnail_path #609 (prisae)

  • MRG, ENH: サブ拡張機能 sphinx_gallery.load_style を提供 #601 (mgeier)

  • [ドキュメント] CSS 設定部分へのマイナーな修正 #594 (lucyleeow)

  • [MRG] [ENH] pandas df のための CSS を追加 #590 (lucyleeow)

  • ENH: backrefs のための CSS クラスを追加 #581 (larsoner)

  • 特定の型の repr を無視する機能を追加 #577 (banesullivan)

修正されたバグ

  • バグ: macOS でのタイムアウトを長くする #629 (larsoner)

  • バグ: 新しい Sphinx のテストを修正 #619 (lucyleeow)

  • MRG, FIX: ピックリングを許可 #604 (larsoner)

  • CSS: サムネイルの高さを 112 px に制限 #595 (mgeier)

  • MRG, FIX: RandomState へのリンクを適切に設定 #593 (larsoner)

  • MRG, FIX: backref スタイリングを修正 #591 (larsoner)

  • メンテナンス: PIL/JPEG のチェックを更新 #586 (larsoner)

  • ドキュメント: コードブロックの言語を修正 #585 (larsoner)

  • [MRG] 直接インポートされていない関数の backreferences を修正 #584 (lucyleeow)

  • バグ: repr None を修正 #578 (larsoner)

  • [MRG] 重複チェックに無視パターンを追加 #574 (lucyleeow)

  • [MRG] backreferences_dir 設定を確認 #571 (lucyleeow)

  • URLError #569 (EtienneCmb)

  • MRG: last/first_notebook_cell の冗長性を削除 #626 (lucyleeow)

  • API リファレンス構造の重複した doc_solver エントリを削除 #589 (kanderso-nrel)

マージされたプルリクエスト

  • ドキュメント: # %% を使用 #624 (lucyleeow)

  • ドキュメント: スクレーパーセクションの repr をキャプチャ #616 (lucyleeow)

  • [MRG+1] ドキュメント: スプリッターのドキュメントを改善し、IDE での使用を説明 #615 (lucyleeow)

  • ドキュメント: テンプレートについて言及 #613 (lucyleeow)

  • 1 つのブロックスプリッターの一貫した使用を推奨 #610 (mikofski)

  • MRG, メンテナンス: CSS を分割し、コントロールを追加 #599 (larsoner)

  • MRG, メンテナンス: 依存関係を更新 #598 (larsoner)

  • MRG, ENH: メソッドとプロパティへのリンクを適切に設定 #596 (larsoner)

  • メンテナンス: nightly の動作を試みる #592 (larsoner)

  • ドキュメントで literalinclude について言及 #582 (emmanuelle)

  • メンテナンス: AppVeyor を 3.7 に上げる #575 (larsoner)

v0.5.0#

開発者向けの変更#

  • マスターを追跡する「dev」ドキュメントと、リリースに従う「stable」ドキュメントを分離。

  • 公式の jpeg サポートを追加。

互換性のない変更#

  • Sphinx < 1.8.3 のサポートを終了。

  • Python < 3.5 のサポートを終了。

  • capture_repr 設定が追加され、デフォルト設定は ('_repr_html_', __repr__') となりました。これにより、既存のプロジェクトで意図しない出力がキャプチャされる可能性があります。以前の動作に戻すには、capture_repr: () を設定してください。

実装された機能拡張

  • イメージスクレイパーの入力を説明 #472

  • JupyterのようにHTML出力をキャプチャ #396

  • 機能リクエスト: セル区切りをカスタマイズするオプションを追加 #370

  • Sphinx拡張機能を並列書き込みセーフとしてマーク #561 (astrofrog)

  • ENH: ビルトインモジュールへのリンクをサポート #558 (larsoner)

  • ENH: 公式のJPGサポートとより良いテストを追加 #557 (larsoner)

  • [MRG] ENH: 最後の式の'repr'をキャプチャ #541 (lucyleeow)

  • ‘README’と‘readme’の両方を検索 #535 (revesansparole)

  • ENH: ビルドを高速化 #526 (larsoner)

  • ENH: 生きたオブジェクト参照とメソッドを追加 #525 (larsoner)

  • ENH: メモリ使用量も表示 #523 (larsoner)

  • [MRG] EHN #%% セル区切りをサポート #518 (lucyleeow)

  • MAINT: 古いPythonとSphinxのサポートを削除 #513 (larsoner)

修正されたバグ

  • ドキュメントが現在のリリースよりも先行 #559

  • JPEGサムネイル生成を修正 #556 (rgov)

  • [MRG] ターミナルrstブロックの最後の単語を修正 #548 (lucyleeow)

  • [MRG][FIX] print(__doc__)から出力ボックスを削除 #529 (lucyleeow)

  • BUG: ループ内のkwargsの変更を修正 #527 (larsoner)

  • MAINT: AppVeyorを修正 #524 (larsoner)

マージされたプルリクエスト

  • [MRG] DOC: ドキュメントに警告フィルターの注釈を追加 #564 (lucyleeow)

  • [MRG] DOC: 各例を説明 #563 (lucyleeow)

  • ENH: dev/stableの区別を追加 #562 (larsoner)

  • DOC update example capture_repr #552 (lucyleeow)

  • BUG: インデックスチェックを修正 #551 (larsoner)

  • FIX: スプリアスな失敗を修正 #550 (larsoner)

  • MAINT: CIsを更新 #549 (larsoner)

  • sphinx-galleryを使用しているプロジェクトのリスト #547 (emmanuelle)

  • [MRG] DOC タイプミスと説明の明確化 #545 (lucyleeow)

  • クリアタグにクラスを追加 #543 (dorafc)

  • MAINT: 3.8の修正 #542 (larsoner)

  • [MRG] DOC: イメージスクレイパーの入力を説明 #539 (lucyleeow)

  • [MRG] タイトルに句読点を使用可能にする #537 (lucyleeow)

  • ドキュメントを改善 #533 (lucyleeow)

  • ENH: アーティファクトへの直接リンクを追加 #532 (larsoner)

  • [MRG] ドキュメントからmatplotlib aggバックエンド + plt.showの警告を削除 #521 (lesteve)

  • MAINT: 最新のpytestの修正 #516 (larsoner)

  • sphinx-galleryユーザーリストにFURYを追加 #515 (skoudoro)

v0.4.0#

開発者向けの変更#

  • 外部スクレイパーが文字列ベースのサポートを持つためのプライベートAPI契約が追加されました。以下を参照してください。

  • 標準エラーがキャッチされ、標準出力と並んで表示されるようになりました。

  • いくつかのSphinxマークアップが、画像サムネイルのツールチップから削除されました。

互換性のない変更#

  • v0.4.0は、Python <= 3.4 をサポートする最後のリリースになります。

  • 今後は、sphinx-galleryの各リリース時に、最新の2つの安定したSphinxリリースのみをサポートします。

実装された機能拡張

  • ENH: テキストからいくつかのSphinxマークアップを削除 #511 (larsoner)

  • ENH: README.rst拡張子を許可 #510 (larsoner)

  • Dockerfileを使用したbinderの要件? #476

  • ENH: ドキュメントを更新 #509 (larsoner)

  • RTD-Binderの非互換性に関するドキュメントの注記を追加 #505 (StanczakDominik)

  • sphinx-galleryユーザーリストにPlasmaPyを追加 #504 (StanczakDominik)

  • ENH: 例のグローバル変数を公開 #502 (larsoner)

  • DOC: ドキュメントを更新 #501 (larsoner)

  • ドキュメントにソースコードを表示するリンクを追加 #499 (sappelhoff)

  • MRG, ENH: 警告をキャッチして書き込む #495 (larsoner)

  • MRG, ENH: 外部スクレイパー用のプライベートAPIを追加 #494 (larsoner)

  • 外部イメージスクレイパーのリストを追加 #492 (banesullivan)

  • sphinx-galleryを使用しているプロジェクトの例をさらに追加 #489 (banesullivan)

  • sphinx_gallery設定コメントを削除するオプションを追加 #487 (timhoffm)

  • FIX: Dockerfileを許可 #477 (jasmainak)

  • MRG: SVGサポートを追加 #471 (larsoner)

  • MAINT: CircleCIビルドを簡略化 #462 (larsoner)

  • リリース v0.3.0 #456 (choldgraf)

  • リリース用のコントリビューションガイドを追加 #455 (choldgraf)

修正されたバグ

  • 「binder」のドキュメントでキーワードが間違っていたのを修正 #500 (sappelhoff)

  • html出力ブロックの'Out:'ラベルの位置を修正 #484 (timhoffm)

  • pytest-coverageの依存関係について言及 #482 (timhoffm)

  • ドキュメント文字列後のreSTブロックを修正 #480 (timhoffm)

  • MAINT: Windowsのmtimeを許容 #478 (larsoner)

  • FIX: コード実行からの出力が削除されない #475 (padix-key)

  • FIX: リンク #470 (larsoner)

  • FIX: メモリプロファイリングの軽微な修正 #468 (larsoner)

  • リリースノートに出力図のナンバリングの変更点を追加 #466 (lesteve)

  • ドキュメントを読むためのリンクを削除 #461 (GaelVaroquaux)

  • [MRG+1] manifest に requirements.txt を追加 #458 (ksunden)

v0.3.1#

バグ修正リリース: パッケージの「pip install」を妨げていた欠落ファイルを追加しました。

修正されたバグ

  • バージョン 0.3.0 リリースは pypi で破損しています #459

v0.3.0#

互換性のない変更#

  • 出力図の番号付けは常に 1, 2, …, number_of_figures です。0.2.0 では matplotlib の図番号に従っていました。sphinx-gallery で生成された図を .. figure ディレクティブを使用して .rst ドキュメントに明示的に含める場合、例でデフォルト以外の matplotlib 図番号を使用している場合 (例えば、plt.figure(0) を使用している場合) は、そのパスを調整する必要があるかもしれません。詳細については、#464 <https://github.com/sphinx-gallery/sphinx-gallery/issues/464> を参照してください。

開発者向けの変更#

  • Sphinx <= 1.4 のサポートを終了しました。

  • 独立した rst ファイル構築のためのリファクタリング。関数 sphinx_gallery.gen_rst.generate_file_rst は、ソースコードの各ブロックを実行中に rst ファイルを構成しなくなりました。現在、例のスクリプト execute_script の実行は独立した関数であり、各ソースブロックの出力の rst 表現をリストで構造化して返します。generate_file_rst は、必要な場合にスクリプトの実行を呼び出し、rst 出力から、例の散文、コード、および出力を含む rst ドキュメントを構成し、Binder バッジ、ダウンロードボタン、およびタイミング統計のアノテーションを含めてファイルに直接保存します。

  • Binder リンク構成の変更。BinderHub の構成値は、より明示的にするために url から binderhub_url に変更されました。古い構成キー (url) はバージョン v0.4.0 で非推奨になります。

  • CircleCI などの CI サービスでビルドするのに役立つ可能性がある 'junit' 構成値を使用して、JUnit XML サマリーファイルを生成するサポート。関連する CircleCI ドキュメント および ブログ記事 を参照してください。

修正されたバグ

  • 最初のギャラリープロットは、matplotlib のデフォルトではなく、.matplotlibrc を使用します #316

マージされたプルリクエスト

  • [MRG+1]: JUnit XML ファイルを出力 #454 (larsoner)

  • MRG: highlight_language を使用 #453 (larsoner)

  • BUG: 実行時間の書き込みを修正 #451 (larsoner)

  • MRG: 3.8 の lineno を調整 #450 (larsoner)

  • MRG: 必要な部分のみを再構築 #448 (larsoner)

  • MAINT: 3.4 を削除、mayavi を 1 つに追加 #447 (larsoner)

  • MAINT: 要件を最新化 #445 (larsoner)

  • Python のプレリリースで travis をアクティブ化 #443 (NelleV)

  • [MRG] binder の指示を更新 #439 (choldgraf)

  • FIX: 最新の sphinx-dev の修正 #437 (larsoner)

  • ファイル名のメモを追加 #436 (choldgraf)

  • FIX: FileNameSortKey クラスのドキュメント文字列のソートを修正 #433 (mrakitin)

  • MRG: 最新の pytest の修正 #432 (larsoner)

  • FIX: バージョンを更新 #431 (larsoner)

  • MRG: より新しい sphinx の修正 #430 (larsoner)

  • DOC: PNGScraper の括弧の欠落 #428 (ksunden)

  • Fix #425 #426 (Titan-C)

  • スクレーパーのドキュメントと画像ファイルパススクレーパー #417 (choldgraf)

  • MRG: 古い cron ジョブを削除 #416 (larsoner)

  • ENH: メモリをプロファイル #415 (larsoner)

  • タイプミスを修正 #414 (zasdfgbnm)

  • FIX: Travis #410 (larsoner)

  • ドキュメントのインデックスページと getting_started の更新 #403 (choldgraf)

  • ノートブックの最初のセルをカスタマイズする機能を追加 #401 (choldgraf)

  • スペルミスを修正 #398 (amueller)

  • [MRG] Circle v2 を修正 #393 (lesteve)

  • MRG: CircleCI V2 に移行 #392 (larsoner)

  • MRG: 1.8.0 dev の修正 #391 (larsoner)

  • ドキュメント生成時に「合計実行時間」を削除 #390 (lamby)

  • タイミング関連のブロック専用クラスを追加 #359 (ThomasG77)

  • MRG: タイミング情報を追加 #348 (larsoner)

  • MRG: ドキュメント文字列から backrefs に ref を追加 #347 (larsoner)

  • API: 画像スクレイピングをリファクタリング #313 (larsoner)

  • [MRG] 例でローカルモジュールをインポートする FIX #305 (NelleV)

  • [MRG] rst ノートブックの生成をスクリプトの実行から分離 #239 (Titan-C)

v0.2.0#

新機能#

  • binder 設定を介して、例の Binder リンクを自動生成する実験的なサポートを追加しました。この API は将来変更される可能性があることに注意してください。 #244 および #371。

  • 一部の Python ファイルをギャラリーに追加しないようにする ignore_pattern 設定可能を追加しました。詳細については、#346 を参照してください。

  • 「RGBA」空間でのカスタムデフォルトサムネイルのサポート #375

  • タイトルのみを許可 -> タイトルを最初の段落として使用 #345

バグ修正#

  • パスに ".py" が含まれるプロジェクトで、名前文字列置換が失敗する問題を修正しました。詳細については、#322 および #331 を参照してください。

  • セル間の __future__ インポートを修正しました。詳細については、#308 を参照してください。

  • ロケールが UTF-8 でない場合のエンコード関連の問題を修正しました。詳細については、#311 を参照してください。

  • 詳細モードでは、例の出力は、最後だけではなく、例の実行中にもコンソールに出力されます。詳細については、#301 を参照してください。

  • sphinx 1.7 における SphinxDocLinkResolver のエラーを修正しました。詳細については、#352 を参照してください。

  • file_pattern と expected_failing_examples の間の予期しない相互作用を修正しました。詳細は #379 および #335 を参照してください。

  • 修正: 出力にスタイルなしの pygments を使用するようにしました #384

  • 修正: パスが '/' で終わる場合のギャラリー名を修正しました #372

  • タイトルの検出ロジックを修正しました。 #356

  • 修正: sphinx 1.8dev での警告を避けるために docutils_namespace を使用するようにしました #387

互換性のない変更#

  • SKLEARN_DOC_OPTIPNG 変数が設定されたときにトリガーされていた optipng 機能を削除しました。詳細については、#349 を参照してください。

  • Backreferences_dir が必須になりました #307

開発者向けの変更#

  • Sphinx <= 1.4 のサポートを終了しました。

  • test_gen_gallery.py に SphinxAppWrapper クラスを追加しました #386

  • リリース方法に関するメモ #360

  • codecov サポートを追加しました #328

v0.1.13#

新機能#

  • min_reported_time 設定可能項目を追加しました。この閾値（秒単位）よりも高速に実行される例については、実行時間が報告されません。

  • thumbnail_size オプションを追加しました #283

  • すべての関数参照解決に intersphinx を使用するようにしました #296

  • ダウンロード用の Sphinx のみディレクティブ #298

  • サブセクションファイルのソートを許可するようにしました #281

  • plot_gallery には、Python のブール値ではなく、文字列を使用することをお勧めします。たとえば、True の代わりに 'True' を使用します。sphinx-build のコマンドラインスイッチ経由でこの値を制御する際の Unicode に関する警告を回避できるためです。

バグ修正#

  • doc_resolv におけるクラッシュ、js_index.loads でのクラッシュ #287

  • gzip/BytesIO エラーを修正しました #293

  • Travis によって提供される virtualenv を非アクティブ化しました #294

開発者向けの変更#

  • Circle CI からドキュメントを github にプッシュするようにしました #268

  • バージョンを Sphinx に報告するようにしました。 #292

  • ログ形式に微調整を加えました。 #285 および #291

v0.1.12#

新機能#

  • ギャラリー内のサブセクションの順序を指定するための明示的な order sortkey を実装しました。 #37, #233, #234 の議論を参照してください。

  • ビルド中のコンソール出力をクリーンアップしました #250

  • 新しい設定テスト #225

バグ修正#

  • 各例を実行する前に sys.argv をリセットするようにしました。詳細については、#252 を参照してください。

  • ドキュメントリゾルバーでエラーを正しく再発生させるようにしました。 #264 を参照してください。

  • 可能な限り https リンクを許可し、使用するようにしました #258

  • HTML 特殊文字のツールチップをエスケープするようにしました。 #249

ドキュメント#

  • numpy へのリンクを最新のものに変更しました #271

  • ドキュメントの依存関係を追加しました。 #267

v0.1.11#

ドキュメント#

  • よくある質問がドキュメントに追加されました。なぜ __file__ が定義されていないのか？

バグ修正#

  • #242 で、Sphinx app オブジェクトの属性名を変更しました

v0.1.10#

バグ修正#

  • #218 で導入された画像パス処理のバグを修正しました

v0.1.9#

互換性のない変更#

  • Sphinx Gallery の例のバックリファレンスはデフォルトで非アクティブ化されるようになりました。 これらをオンにして、ファイルを保存するディレクトリを設定するのは、ユーザーの責任です。 #126 およびプルリクエスト #151 の議論を参照してください。

バグ修正#

  • Windows ビルドでのダウンロード zip ファイルのパスを修正しました。 #218 を参照してください

  • 埋め込みのリンク切れを修正しました。 #214 を参照してください

開発者向けの変更#

  • テストを py.test に移行しました

  • ドキュメントに github リポジトリへのリンクを含めました

v0.1.8#

新機能#

  • コードリンクのツールチップのスタイリングを削除しました。ブラウザによって管理される title 属性に置き換えました。

  • リンクを埋め込むとギャラリーの出力が短くなるようにしました

  • Circle CI テスト

バグ修正#

  • 例に構文エラーがあっても Sphinx-Gallery をビルドできるようにしました。 #177 を参照してください

  • ソースディレクトリから Makefile を実行する必要がなくなり、任意のパスから sphinx-build を直接呼び出すことで Sphinx-Gallery をビルドできるようになりました。詳細については、#190 を参照してください。

v0.1.7#

バグ修正#

  • リリースされた Sphinx 1.5 には自動生成されたファイルに対する新しい命名規則があり、Sphinx-Gallery ドキュメントスキャナーが壊れていました。 #178 で修正され、Sphinx < 1.5 で生成されたドキュメントと 1.5 以降の新しいドキュメントへのリンクに対応しています

  • コードリンクのツールチップがコードと左揃えになるようにしました

新機能#

  • Windows での Sphinx-Gallery の開発サポート #179 & #182

v0.1.6#

新機能#

  • Python スクリプトを Jupyter Notebook に変換するための実行可能スクリプト #148

バグ修正#

  • matplotlib バックエンドを 'agg' に設定できない場合、Sphinx-Gallery は例外を発生させるようになりました。これは、たとえば conf.py で matplotlib.pyplot がインポートされている場合に発生する可能性があります。詳細については、#157 を参照してください。

  • モジュールが属性なしで使用されている場合の backreferences.identify_names を修正しました #173。 #172 および #149 を閉じます

  • 例のギャラリーのメインディレクトリに README.txt が存在しない場合、FileNotFoundError を発生させるようにしました(#164)。 また、README.txt を読み取った後、html ファイルを正しくレンダリングするために余分な空行を含めるようにしました。(#165)

  • PyPI リリースにライセンスファイルを同梱するようにしました

v0.1.5#

新機能#

  • CSS。ソースコードブロックにツールチップが表示されるようになり、doc-resolv 機能が見つけやすくなりました。 ソースコードブロック内の関数呼び出しは、オンラインドキュメントへのハイパーリンクです。

  • ダウンロードボタンが、Sphinxで提供されるすべてのテーマでより見栄えが良くなりました。

開発者向け変更点#

  • Sphinx-Galleryドキュメントのローカルビルドでのテーマのオンザフライ変更をサポートします。makeターゲットに変数themeを渡すと、新しいテーマでドキュメントがビルドされます。すべてのSphinxテーマと、この使用例に示すように、値rtdでread the docsオンラインテーマが利用可能です。

    $ make html theme=rtd

  • Ubuntu 14パッケージでのSphinx Galleryのサポートをテストし、Ubuntu 12のサポートを削除します。conda環境でのPython 2.6のサポートを削除します。

v0.1.4#

新機能#

  • ダウンロードボタンのCSSを強化

  • ギャラリーの最後に、すべてのPythonスクリプトまたはJupyterノートブックをzipファイルにまとめてダウンロードするためのダウンロードボタンを追加。この効果を切り替えるための新しい設定変数download_all_examples。デフォルトで有効

  • 各ギャラリーのすべての例をPythonスクリプトとノートブックとしてまとめたダウンロード可能なzipファイル

  • Jupyterノートブックのテキストブロック用に、rstディレクティブからmarkdownへの変換を改善

バグ修正#

  • 例の中でseabornがインポートされた場合、プロットスタイルの設定が、後で実行されるプロットに引き継がれます。CIは、mayavi-pandas-seabornとnomklの互換性のあるバージョンをconda環境で取得し、すべての機能を利用できるようにする方法をユーザーが追跡できるように設定されています。

  • インライン数式と複数行の数式について、例のrstからJupyterノートブックテキストへの数式変換を修正

v0.1.3#

新機能#

  • sphinxビルドの最後に、トレースバックを含む失敗した例の概要を表示。デフォルトでは、例が失敗した場合、ビルドは終了コード1で終了します。conf.pyで失敗することが予想される例のリストを定義し、終了コード0でビルドを終了させることができます。または、1つの例が失敗するとすぐにビルドを終了させることも可能です。

  • ビルド中に、すべての例の計算時間の集計およびソートされたリストをコンソールに出力。

  • 複数の図を作成する例について、サムネイル画像を設定。

  • plot_galleryおよびabort_on_example_errorオプションは、sphinx_gallery_confで指定できるようになりました。ビルドオプション（sphinx-buildに渡される-Dフラグ）は、sphinx_gallery_confオプションよりも優先されます。

バグ修正#

  • 失敗した例は、ビルドごとに再試行されます。

v0.1.2#

バグ修正#

  • if __name__ == '__main__'ガードを使用する例が実行されるようになりました

  • ノートブックではない例で、コード出力とコードソースの間に垂直方向のスペースを追加

v0.1.1#

バグ修正#

  • html-noplot機能を復元

  • ギャラリーのCSSで、サムネイルの幅が暗黙的に強制されるようになりました

v0.1.0#

ハイライト#

例のスクリプトをIPython Notebookとしてダウンロードできるようになりました #75

新機能#

  • ギャラリーのビルド中にどの例のスクリプトを実行するかを選択するための、設定可能なファイル名パターン

  • 例のスクリプトの更新チェックは、日付ではなくmd5sumチェックによるようになりました

  • 破損した例は、ギャラリービューに破損したサムネイルを表示し、レンダリングされた例の中にトレースバックが出力されます。ユーザーは、例が失敗するとすぐにビルドプロセスを中止するように設定することもできます。

  • スクリプトサイズによる例のソート

  • 例のスタイルを改善

v0.0.11#

ハイライト#

このリリースには、PR #36によるギャラリーのノートブックスタイルの例が含まれています

互換性のない変更#

Sphinx-Galleryは、Pythonモジュール名をsphinx_galleryにリネームしました。これは#47で提起され、#66で解決された議論に従ったものです。

ギャラリー設定の辞書も、名前をsphinx_gallery_confに変更します

PR #36から、画像、サムネイル、参照の新しい名前空間の規則が決定されました。コメントを参照してください

v0.0.10#

ハイライト#

このリリースでは、バックリファレンスを使用できます。この機能は、特定の関数を使用している例を一覧表示する、きめ細かい例のギャラリーを取り入れています。#26

新機能#

  • Sphinx-Galleryのローカルコピーをプロジェクトに配置するためのシェルスクリプト

  • ギャラリーでのMayaviプロットのサポート

このページについて