Как сортировать предметы на Сфинксе - PullRequest
0 голосов
/ 20 февраля 2020

Я использую read-the-docs для предоставления документации. Под капотом я использую Sphinx + RestructuredText. Однако некоторые страницы не отсортированы из-за большого количества обновлений, сделанных в прошлом, поэтому я хотел бы показать эти страницы в алфавитном порядке. Я мог бы изменить каждый документ вручную, но это занимает много времени, поэтому я хотел бы найти другую альтернативу.

Sphinx предлагает директиву : sorted: для глоссарий это то, что я хочу, но это работает только для глоссария. Если у меня есть обычная страница, я не могу использовать ту же альтернативу, например:

.. spelling::

  isysroot

.. _tools:

Tools
=====

Under the tools module there are several functions and utilities:

.. code-block:: python
   :emphasize-lines: 2

    from pkg import tools

    class Example(object):
        ...

.. _tools_unzip:

tools.unzip()
-------------

.. code-block:: python

    def unzip(filename,)

Function mainly used to unzip .zip files.

.. _tools_cpu_count:

tools.cpu_count()
-----------------

.. code-block:: python

    def tools.cpu_count()

Returns the number of CPUs available.

.. _tools_vcvars_command:

tools.vcvars_command()
----------------------
....

. В этом примере Sphinx будет отображаться в следующем порядке: tools.unzip , tools.cpu_count , tools.vcvars_command . Тем не менее, я хотел бы показать его в алфавитном порядке, независимо от порядка документа.

Есть ли какие-либо подсказки об этом при использовании Sphinx?

...