sorting - 如何反转 "glob"标志选项提供的 toctree 的顺序？

Question

有谁知道按文件名降序排列 toctree 的任何选项？
在升序的情况下，我们可以使用 :glob:像这样的选项:

.. toctree:
   :glob:

   2011*

这对于应该在 Sphinx 文档中报告的以重组文本编写的日常笔记非常方便。

Answer 1

没有简单的选项可以对 toctree 进行反向排序。但是您可以通过在将文档写入文件之前修改文档结构来实现。这是一个建议。将以下代码添加到 conf.py :

def reverse_toctree(app, doctree, docname):
    """Reverse the order of entries in the root toctree if 'glob' is used."""
    if docname == "index":
        for node in doctree.traverse():
            if node.tagname == "toctree" and node.get("glob"):
                node["entries"].reverse()
                break

def setup(app):
    app.connect("doctree-resolved", reverse_toctree)

reverse_toctree() doctree-resolved时调用回调函数事件被触发。该函数定位 toctree文档树中的节点并就地更改它。

有关 Sphinx 和 Docutils API 的更多详细信息:

https://www.sphinx-doc.org/en/master/extdev/appapi.html

http://docutils.sourceforge.net/docs/ref/doctree.html