Frage

Die Dokumentation für die Unsicherheiten Python-Paket in reStructuredText geschrieben wird, für die Sphinx Dokumentationssystem. Die HTML- sieht gut . Ich möchte eine PDF-Version erstellen. Das Ziel ist es, ein „Kapitel“ für jede der Web-Seite zu haben.

Doch was passiert, ist, dass das PDF erzeugt durch die ReST Dateien Transformationen die (HTML) Abschnitte von index.html in einzelne Kapitel (was ich nicht will: die PDF sie als Abschnitte haben sollte). Ein weiteres Problem ist, dass alle HTML-Seiten, die nach der Hauptseite erscheinen in der PDF-Datei als Unterabschnitte des Abschnitts, wo die toctree Richtlinie erscheint (das heißt, in dem Empfangsabschnitt der Haupt-Seite).

Also, wie sollte die ReST Datei so strukturiert sein, dass (1) die Web-Dokumente aussehen die gleiche, wie sie sind jetzt , und (2) jeder Web-Seite entspricht ein PDF Kapitel. Jede Hilfe wäre sehr geschätzt!

War es hilfreich?

Lösung

Es gibt eine Lösung . Wenn ich mich richtig erinnere, die wichtigsten Punkte waren:

  • Verwenden Sie ein spezielles Inhaltsverzeichnis als Master-Dokument (I verwendet index_TOC.rst anstelle des Standard-index.rst): in conf.py
    • master_doc = 'index_TOC'
    • latex_documents = [('index_TOC', 'uncertaintiesPythonpackage.tex',…]
  • Die neue Inhaltsdatei index_TOC.rst enthält ein ToC wie

    TOC
    ===
    
    .. toctree::
       :hidden:
       :maxdepth: 1
    
       index
       user_guide
       numpy_guide
       tech_guide
    

Damit die Web-Version öffnet sich nach wie vor auf die Haupt index.rst Text und PDF (LaTeX) Version hat jede ReST Datei in einem separaten Kapitel .

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top