W dokumentacji Sphinx, w jaki sposób mogę odwrócić kolejność roszczenia, które jest dostarczane przez opcję flagi "glob"?

Question

Czy ktoś wie jakąkolwiek opcję zamówienia toctree w porządku malejącym nazw plików? W przypadku rosnącej kolejności, możemy użyć: glob: opcja tak:

.. toctree: 
    :glob: 

    2011* 

Byłby przydatny do codziennych notatek pisanych w restructuredtext które powinny być zgłaszane w dokumencie Sphinx.

Answer 1

Nie ma prostej opcji odwrotnego sortowania wartości losowej. Ale możesz to zrobić, modyfikując strukturę dokumentu, zanim zostanie zapisany do pliku. Oto sugestia. Dodaj następujący kod do 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) 

Funkcja reverse_toctree() zwrotna jest wywoływana, gdy zdarzenie doctree-resolved jest zwolniony. Funkcja lokalizuje węzeł toctree w drzewie dokumentu i zmienia go na miejscu.

Więcej szczegółów na temat Sphinx i Docutils API:

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

Answer 2

Dodaje odwrócony opcję 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) 

który pozwala zrobić:

Contents: 

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

    20* 

Answer 3

Jako Sfinks 1.5+ jest wbudowany :reversed: flagą można dodać do toctree:

.. toctree:: 
    :glob: 
    :reversed: 

    2011* 

Aby uzyskać więcej informacji, patrz the Sphinx documentation.