2014-06-09 5 views
22

Wie fügt man ein lokales Inhaltsverzeichnis in Sphinx doc ein?Wie fügt man eine lokale Tabelle von Inhalten in Sphinx doc ein?

Ich versuchte

.. toc:: 

Aber das scheint keine Wirkung zu haben: nichts wird in das Dokument eingefügt.

Grundsätzlich brauche ich Links zu den Abschnitten in der aktuellen Seite an einer bestimmten Stelle jeder Seite platziert werden.

Ist das möglich?

Antwort

24

Ich bin nicht 100% sicher, dass das ist, was Sie suchen, aber die .. contents:: Direktive kann helfen. Standardmäßig erhalten Sie die Überschriften für die gesamte Seite, unabhängig davon, wo Sie die Anweisung ablegen. Mit :local: angegeben, wird es ein lokales Inhaltsverzeichnis für die Überschriften generieren, unter denen Sie die Anweisung setzen (praktisch für Unterabschnittstoks).

Weitere Details hier: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

+3

'.. Inhalt ::: local:' ist das Zaubersaft. Wenn Sie das Flag ': local:' weglassen, wird das Inhaltsverzeichnis sinnlos durch einen Link zur Überschrift des Dokuments vorangestellt. Darüber hinaus sind alle anderen Überschriften Unterüberschriften der Überschrift des Dokuments und daher nutzlos um eine Stufe tiefer eingerückt, als sie es sonst sein sollten. Kurz gesagt, ': local:' ist für die meisten Anwendungsfälle nahezu obligatorisch. (_Ich wünschte wirklich ': local:' waren der Standard, ehrlich gesagt._) –