Kommentiert Sphinx toctree

Question

Die übliche Verwendung von toctree in Sphinx etwa wie folgt aussieht:

.. toctree:: 
    :maxdepth: 2 

    foo 
    bar 
    baz 

und wenn zum Beispiel foo.rst beginnt mit einem Titel Überschrift "Being Foo", bar.rst beginnt mit "Doing Bar", und baz.rst beginnt mit „Denken Baz“ dann werden Sie ein schönes Inhaltsverzeichnis erhalten, die wie folgt aussieht:

• Being Foo
• Doing Bar
• Thinking Baz

mit Links von jedem auf die entsprechende Seite.

Meine Frage: gibt es eine Möglichkeit, einen Toctree zu kommentieren? Wenn ich zum Beispiel die Überschrift "Being Foo" mit etwas wie "W. Robert Foo hat die erste metasytaktische Variable 1857 erstellt haben und wir sie seither verwenden.", Dann könnte ich diesen Text irgendwo einfügen (hoffentlich an der Spitze der foo.rst, aber wenn nicht, dann in der toctree-Richtlinie) und die toctree Ausgabe würde wie folgt aussehen:

• Being Foo — W. Robert Foo die erste Metasyntaktische Variable im Jahr 1857 geschaffen und wir haben gewesen benutze es seitdem.
• Doing Bar
• Thinking Baz

Answer 1

können Sie den Seitentitel überschreiben Sie die folgende Syntax verwendet:

.. toctree:: 
    :maxdepth: 2 

    Being Foo - W. Robert Foo created the first metasyntactic variable in 1857 <foo> 
    bar 
    baz 

http://www.sphinx-doc.org/en/stable/markup/toctree.html?highlight=entries

Allerdings würden Sie dann verlieren die Auto-Titel, der kann der Hauptteil deiner Frage sein?