Wie die toctree in der sidebar auf jeder Seite

Ich bin generieren der html-Dokumentation in der Sphinx.

Wie ändere ich die sidebar für jede der html-Seiten in meinem Dokument so, dass die toctree? Standardmäßig ist die toctree scheint nur die Anzeige in der master_doc Seite, und nur in der main-Gebiet statt der sidebar.

Gibt es eine einfache Möglichkeit, dies zu tun? Ich werde mit readthedocs zum hosten der generierten Dokumentation, so würde ich es vorziehen zu vermeiden, die Verwendung von Drittanbieter-plugins, es sei denn, Sie sind auf readthedocs.

InformationsquelleAutor Travis Bear | 2013-09-23
  1. 46

    Können Sie Ihre html-sidebar in conf.py.

    Den Standard-html-sidebar besteht aus 4 Vorlagen:

    ['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']

    In conf.py könnte man ändern localtoc.html zu globaltoc.html wie diese:

    html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }

    Da diese am Ende wird in HTML-Dateien sollte diese Arbeit auf ReadTheDocs.

    • Diese Lösung funktionierte gut auf readthedocs.
    • Ab Dez 2016 - Diese option ist nicht in der Standard-sphinx conf.py, man kann also nicht die Suche nach 'html_sidebars', aber wenn Sie es, es funktioniert.
    • In der Tat, arbeiten auf die Dokumentation Lesen. Ich entfernte nachgestellte Komma, das war unnötig. Danke, shry! ?
    InformationsquelleAutor shry
  2. 6

    Einschließlich der 'globaltoc.html' hat einen Nachteil, dass es nicht zeigen, sowohl in der globalen und lokalen Inhaltsverzeichnis für die Seite, die Sie gerade betrachten.

    Scheint es, dass andere waren verärgert über diese Einschränkung und führte in der späteren Entwicklung eine Erweiterung zur Unterstützung einer vollständige Inhaltsverzeichnis in der Seitenleiste, Kasse: https://pypi.python.org/pypi/sphinxcontrib-fulltoc

    • Dies funktioniert hervorragend! Aber ich musste pip install --upgrade setuptools erste, sonst wird es nicht installiert werden konnte mit einem seltsamen Fehler: AttributeError: '_NamespacePath' object has no attribute 'sort'
    • Ich habe derzeit diesen Fehler gemeldet, wenn readthedocs versucht, diese zu installieren.
    • Ich vermute, github.com/sphinx-contrib/fulltoc/issues/14 ist der Grund dafür, ich werde sehen, was sich in Kürze.
    InformationsquelleAutor dbailey
Schreibe einen Kommentar