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 (list、tuple 或 產生器) – 保留每個圖庫子章節的路徑。

引發:

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 (可呼叫) – 排序鍵函數，只能接受一個引數，例如 lambda func = arg: arg[0] * arg[1]

• r (str, None) – 物件的可列印表示法

class sphinx_gallery.sorting.NumberOfCodeLinesSortKey(src_dir)

依程式碼行數排序 src_dir 中的範例。

參數:

src_dir (str) – 來源目錄。