sphinx_gallery.sorting

Sphinx-Gallery (サブ)セクションのソーター。

ギャラリーサブセクションフォルダとセクションファイルのソートキー関数。

クラス

class sphinx_gallery.sorting.ExampleTitleSortKey(src_dir)

src_dir内のサンプルをサンプルタイトルでソートします。

パラメーター：

src_dir (str) – ソースディレクトリ。

class sphinx_gallery.sorting.ExplicitOrder(ordered_list)

すべてのギャラリーサブセクションのソートキー。

すべてのサブセクションフォルダをリストに含める必要があります。そうでない場合は例外が発生します。「*」をプレースホルダーとしてリストに追加できます。リストされていないすべてのサブセクションフォルダは、指定された位置に挿入され、例外は発生しません。

パラメーター：

ordered_list (リスト、タプル、またはジェネレーター) – 各ギャラリーのサブセクションのパスを保持します。

例外：

ValueError – 不正な入力タイプ、またはサブギャラリーパスがありません。

class sphinx_gallery.sorting.FileNameSortKey(src_dir)

src_dir内のサンプルをファイル名でソートします。

パラメーター：

src_dir (str) – ソースディレクトリ。

class sphinx_gallery.sorting.FileSizeSortKey(src_dir)

src_dir内のサンプルをファイルサイズでソートします。

パラメーター：

src_dir (str) – ソースディレクトリ。

class sphinx_gallery.sorting.FunctionSortKey(func, r=None)

sorted()に渡された関数を使用してサンプルをソートします。

パラメーター：

• func (呼び出し可能) – ソートキー関数。1つの引数のみを取ることができます。例：lambda func = arg: arg[0] * arg[1]

• r (str, None) – オブジェクトの印刷可能な表現

class sphinx_gallery.sorting.NumberOfCodeLinesSortKey(src_dir)

src_dir内のサンプルをコード行数でソートします。

パラメーター：

src_dir (str) – ソースディレクトリ。