Wie fügt man Sphinx-generierten Index zur Seitenleiste hinzu, wenn Sie das Thema Docs lesen?

Question

Wie fügt man Sphinx-generierten Index zur Seitenleiste hinzu, wenn Sie das Thema Docs lesen?

9

Ich möchte einen Link zu dem automatisch generierten Index in der Seitenleiste haben, wenn sphinx-rtd-theme verwendet wird. Ich habe versucht, es in den Baum zu fügen:

%Vor%

aber dies führte zu

%Vor%

von Sphinx und keine andere Wirkung.

Ich denke, ich könnte den Index einfach im Thema layout.html file fest codieren, aber vielleicht gibt es einen besseren Weg, das Standardthema nicht zu verändern?

TIA für irgendwelche Hinweise!

python-sphinx read-the-docs

VZ. 11.08.2014, 12:36

quelle

2 Antworten

-1

Wie wäre es mit:

%Vor%

Steven Almeroth 25.02.2015 00:43

quelle

Tags und Links python-sphinx read-the-docs

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Vergleichen von Java Swing MVC mit Android Design Pattern

score 6 · Accepted Answer

Es ist leicht, wenn du verstehst, wie Sphinx und Jinja arbeiten, leider die Sphinx-Dokumente zum Templating gib dir nicht genügend Informationen, wenn du es nicht tust.
Kurz gesagt, Sie müssen die Vorlage überschreiben:

Stellen Sie sicher, dass Sie einen _templates -Ordner unter Ihrem sphinx docs-Ordner haben.
Stellen Sie sicher, dass es in Ihrem conf.py aufgeführt ist, z. %Code%
Erstellen Sie eine Datei im Ordner templates_path = ['_templates'] .
Fügen Sie dieses Snippet ein und speichern Sie es. Das Ausrufezeichen / die Markierung zwingt jinja zur Verwendung der übergeordneten Vorlage. Vergiss es nicht, sonst bekommst du einen Rekursionsfehler. Sie müssen nur den layout.html -Block außer Kraft setzen.
%Vor%