教程：使用Sphinx-Gallery库中的FileNameSortKey()函数对文件名进行排序

Sphinx-Gallery是一个用于生成可重复运行的示例和教程的库。它可以根据文件名对示例进行自动排序。在Sphinx-Gallery中，可以使用FileNameSortKey()函数对文件名进行排序。本教程将介绍如何使用FileNameSortKey()函数以及它的使用示例。

首先，你需要安装Sphinx-Gallery库。可以使用以下命令通过pip安装：

pip install sphinx-gallery

安装完成后，你需要创建一个新的Sphinx项目。在Sphinx项目的conf.py文件中，你需要添加以下代码来导入FileNameSortKey()函数：

import sphinx_gallery.sorting
from sphinx_gallery.sorting import FileNameSortKey

接下来，在项目的conf.py文件中，你需要指定Sphinx-Gallery使用FileNameSortKey()函数来对示例进行排序。将以下代码添加到conf.py的configuration字典中：

# 指定Sphinx-Gallery使用FileNameSortKey()函数来对示例进行排序
sphinx_gallery_conf = {
    ...
    'sorting_gallery': True,
    'within_subsection_order': FileNameSortKey,
    ...
}

这样，Sphinx-Gallery将使用FileNameSortKey()函数对示例进行排序。FileNameSortKey()函数按文件名的字母顺序对示例进行排序，因此文件名更小的示例将显示在前面。

现在，让我们来看一个使用FileNameSortKey()函数的例子。假设你有一个包含多个示例的文件夹，并希望按示例文件名的字母顺序对它们进行排序。

首先，在你的Sphinx项目的文件夹中创建一个名为"examples"的文件夹。在该文件夹中，创建一个名为"example1.py"的示例文件，内容如下：

def example_function():
    print("This is example 1.")

example_function()

接下来，在"examples"文件夹中创建一个名为"example2.py"的示例文件，内容如下：

def example_function():
    print("This is example 2.")

example_function()

现在，在你的Sphinx项目的.rst文件中，你可以使用以下指令来添加示例代码：

.. only:: html

    .. image:: examples/example1.py

.. only:: html

    .. image:: examples/example2.py

以上代码将会将示例代码渲染为HTML格式。当你构建你的Sphinx项目时，Sphinx-Gallery将自动使用FileNameSortKey()函数对示例进行排序，并按字母顺序显示它们。

通过这个例子，你应该能够理解如何使用Sphinx-Gallery库中的FileNameSortKey()函数对文件名进行排序。你可以根据自己的需要修改示例代码和文件名，并使用FileNameSortKey()函数来对示例进行排序。希望这个教程能够帮助你更好地理解和使用Sphinx-Gallery库中的FileNameSortKey()函数。