Wie kann ich eine benutzerdefinierte Fußzeile zu Sphinx-Dokumentation? (reStructuredText)

Wenn ich einige Unterlagen, wie zum Beispiel Galleria Dokumentation, wie kann ich es so einrichten, dass wenn ich das make html Befehl wird es fügen Sie eine benutzerdefinierte Fußzeile auf jeder Seite?

Sah ich, dass ich konnte potenziell verwenden die latex-Präambel Abschnitt conf.py wenn ich die Ausgabe in eine pdf-format.

Dank!

InformationsquelleAutor cwd | 2011-04-07
  1. 30

    Müssen Sie erweitern das Standard-layout, indem Sie eine html-Datei wie folgt:

    {% extends '!layout.html' %}

{% block footer %}
        <!-- your html code here -->
{% endblock %}

    Speichern Sie diese in einem _templates/ Unterverzeichnis als layout.html und stellen Sie sicher, dass conf.py wo finden Sie dieses Verzeichnis:

    # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

    Mehr Informationen zum Template finden Sie hier: http://sphinx.pocoo.org/templating.html

    • Danke! Dies funktionierte sehr gut!
    • Dort finden Sie auch die layout.html Datei, die Sie überschreiben in Ihrem sphinx-install-Verzeichnis. Dann können Sie kopieren aus dem {% block %} - Abschnitt und setzen Sie Sie außer Kraft pro UncleZeiv den Anweisungen, und ändern Sie nur die bits, die Sie ändern möchten. Meine Datei war auf <pythondir>\Lib\site-packages\Sphinx-1.1.3-py2.7.egg\sphinx\themes\<themename>\layout.html
    • Falls sich jemand wundert, der Standard-Speicherort für die _templates Verzeichnis (basierend auf der templates_path Einstellung in conf.py) ist im selben Verzeichnis, die conf.py ist, die source - Verzeichnis. Auch, wenn Sie möchten, dass Ihre Fußzeile haben den gleichen Stil wie die Standard-Fußzeile, müssen Sie umgeben Sie Ihre Fußzeile, ist das HTML in ein <div class="footer"> tag.
    • Gibt es eine Möglichkeit, ändern Sie die Fußzeile in der generierten PDF-Datei? Ich bin immer "INHALTE", die es gibt, und während diese Lösung funktioniert für die html -, wäre es schön zu wissen, dass der PDF-version!
    • > Wenn Sie übergehen einen block, Aufruf {{ super() }} irgendwo zum Rendern der block-Inhalt in die erweiterte Vorlage – es sei denn, Sie wollen nicht, dass der Inhalt zu zeigen: docs.
    • Für RTD-Thema: {% extends '!footer.html' %} {% block extrafooter %} <!-- your html code here --> {% endblock %}

    InformationsquelleAutor UncleZeiv
Schreibe einen Kommentar