Sphinxのドキュメントでは、「glob」フラグオプションによって提供されるtoctreeの順序を元に戻すにはどうすればよいですか？

Question

ファイル名の降順でtoctreeを注文するオプションはありますか？ は、昇順の場合は、我々は使用することができます。グロブ：このようなオプションは：

.. toctree: 
    :glob: 

    2011* 

これはSphinxのドキュメント内で報告されるべきである再編テキストで書かれた日常のメモに便利だろう。

Answer 1

toctreeを逆ソートする単純なオプションはありません。しかし、ファイルに書き込まれる前に文書の構造を変更することでそれを行うことができます。ここに提案があります。 conf.pyに次のコードを追加しますdoctree-resolvedイベントが発生したときに

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()コールバック関数が呼び出されます。この関数は、文書ツリー内のtoctreeノードを探し、インプレースで変更します。スフィンクスとDocutilsのAPIに関する

詳細：

• http://sphinx.pocoo.org/ext/appapi.html
• http://docutils.sourceforge.net/docs/ref/doctree.html

Answer 2

これはtoctreeに反転オプションが追加されます。

あなたが行うことができます

from sphinx.directives import TocTree 
from docutils.parsers.rst import directives 

class NewTocTree(TocTree): 
    option_spec = dict(TocTree.option_spec, 
         reversed=directives.flag) 

    def run(self): 
     rst = super(NewTocTree, self).run() 
     if 'reversed' in self.options: 
      rst[0][0]['entries'].reverse() 
     return rst 

def setup(app): 
    app.add_directive('toctree', NewTocTree) 

：スフィンクスのよう

Contents: 

.. toctree:: 
    :maxdepth: 2 
    :reversed: 
    :glob: 

    20* 

Answer 3

1.5+あなたはtoctreeに追加できるビルトイン:reversed:フラグがあります：

.. toctree:: 
    :glob: 
    :reversed: 

    2011* 

は、詳細については、 the Sphinx documentationを参照してください。