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, or generator) – 保存每个画廊子节的路径。

引发：

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 (callable) – 排序键函数，只能接受一个参数，例如 lambda func = arg: arg[0] * arg[1]

• r (str, None) – 对象的可打印表示形式

class sphinx_gallery.sorting.NumberOfCodeLinesSortKey(src_dir)

按代码行数对 src_dir 中的示例进行排序。

参数：

src_dir (str) – 源目录。