Mein `pdf` generiert durch RTD hat alle Artikel in der Überschrift Inhalt Warum?

Question

Ich habe gerade erst (gestern) begonnen, Sphinx zu benutzen und die Dokumente für meine project zu lesen.

Bis jetzt bin ich glücklich mit der HTML-Dokumentation, aber die pdf-Version enthält alle Artikel, die im Index innerhalb der Überschrift Inhalt erscheinen. Und der Dokumente orignal Inhalt/Index besteht einfach aus zwei Links.

Bitte helfen.

Die Dokumentation befindet sich unter http://todx.rtfd.io und das PDF ist here.

Answer 1

Bei der PDF-Erzeugung fügt Sphinx immer den Inhalt hinzu, der über eine .. toctree::-Anweisung genau dort referenziert wird, wo die Direktive steht. Im Gegensatz dazu platziert Sphinx beim Erstellen von HTML den Inhalt nach die Datei, die die toctree enthält.

In diesem Aspekt sind PDF-Generierung und HTML-Generierung einfach inkonsistent.

Daher sollten Sie den Inhalt der Indexseite vor das Inhaltsverzeichnis legen.

Wenn Sie einen Überblick über die wichtigsten Abschnitte inline bereitstellen möchten, können Sie eine Liste von references verwenden. Dann möchten Sie möglicherweise die toctree mithilfe der hidden Eigenschaft ausblenden, zum Beispiel wie folgt: