Sphinx toctree zeigt entweder ein Inhaltsverzeichnis in der Seitenleiste mit einer Aufzählungsliste im Hauptteil oder gar nichts an

8

Ich arbeite mit Sphinx (sphinx-1.2b1-py2.7). Ich möchte, dass ein Inhaltsverzeichnis in einer Seitenleiste angezeigt wird. Es scheint binär: Ich kann nur ein Inhaltsverzeichnis in der Seitenleiste und eine Aufzählung im Textkörper erhalten, oder ich bekomme nichts (kein Inhaltsverzeichnis in der Seitenleiste und keine Aufzählung).

Wenn ich die toctree-Anweisung wie folgt verwende:

%Vor%

Ergebnis: kein Inhaltsverzeichnis in der Seitenleiste, keine Aufzählungsliste von Themen im Hauptteil.

Wenn ich die toctree-Anweisung wie folgt verwende:

%Vor%

Ergebnis: TOC in der Seitenleiste UND eine Aufzählung Liste der Themen im Körper.

Ich möchte nur das Inhaltsverzeichnis in der Seitenleiste. Andere Befehle (maxdepth, includehidden) funktionieren nicht. Ich habe es gesehen, aber ich kann es nicht zur Arbeit bringen. Der conf.py sieht gut aus, aber nach mehreren Tagen der Suche nach einer Antwort kein Glück. Danke.

    
user2498859 19.06.2013, 14:49
quelle

1 Antwort

4

Ich hatte auch Probleme damit; Ich fand die Antwort hier .

Das TOC wird über einen Aufruf von toctree() inside angezeigt, z. B. eine Datei namens layout.html. Insbesondere wird es in der Seitenleiste über ein Codeschnipsel ähnlich dem folgenden angezeigt, das sich in <div class="sidebar"> befindet:

%Vor%

Da ich ein Theme verwende, befindet sich layout.html im Theme-Verzeichnis innerhalb des Verzeichnisses _themes; Ansonsten könnte sich layout.html im Verzeichnis _templates befinden.

In neueren Versionen von Sphinx wird benötigt, um das Inhaltsverzeichnis anzuzeigen, wenn :hidden: wie in

verwendet wird %Vor%

ist das Hinzufügen des Arguments includehidden=True zum Aufruf von toctree() , wie in

%Vor%     
Rahul Savani 30.12.2013 14:13
quelle

Tags und Links