Sphinx: Der Dokumentengenerator#

Sphinx ist ein Dokumentengenerator. Er verwendet ein einfaches Textformat namens reStructuredText („reST“) als Quelltext für für den Textinhalt und erzeugt daraus, je nach Bedarf, unterschiedliche Ausgabeformate (PDF, Webseiten, E-Books u. a.).

digraph { rankdir="LR"; "Projektordner" [ shape=cylinder, color=black, style=filled, fillcolor=grey, fontcolor=black, fontname="Source Code Pro", label="RST-Quelltext", width = 2; height = 2; ]; "Sphinx-Compiler" [ shape=cds, color=mediumblue, style=filled, fillcolor=mediumblue, fontcolor=white, fontname="Source Sans Pro", label="Sphinx-Compiler", ]; "html" [ shape=note, color=mediumblue, fontcolor=mediumblue, fontname="Source Sans Pro", label="Webseite\nHMTL" width = 2; ]; "LaTeX" [ shape=note, color=mediumblue, fontcolor=mediumblue, fontname="Source Code Pro", label="LaTeX\ntex" ]; "LaTeX/Compiler" [ shape=cds, style=filled, fillcolor="#a61017", color="#a61017", fontcolor=white, fontname="Source Sans Pro", label="LaTeX-Compiler" ]; "LaTeX/Compiler/pdf" [ shape=note, color="#a61017", fontcolor="#a61017", fontname="Source Sans Pro", label="Print\nPDF" width = 2; ]; "epub" [ shape=note, color=mediumblue, fontcolor=mediumblue, fontname="Source Sans Pro", label="E-Book\nePUB" width = 2; ]; "Projektordner" -> "Sphinx-Compiler"; "Sphinx-Compiler" -> "html" [color=mediumblue]; "Sphinx-Compiler" -> "epub" [color=mediumblue]; "Sphinx-Compiler" -> "LaTeX" [color=mediumblue]; "LaTeX" -> "LaTeX/Compiler" -> "LaTeX/Compiler/pdf" [color="#a61017"]; {rank = same; "LaTeX/Compiler/pdf"; html; epub; } }

Abb. 7 Sphinx kann verschiedene Ausgabeformate erstellen#

Zur Erstellung von Print-Ausgaben im PDF-Format verwendet Sphinx das bewährte und leistungsfähige LaTeX-Schriftsatzsystem. Dies ermöglicht die Erstellung einer qualitativ hochwertige Druckausgabe bei gleichzeitig hoher Anpassungsmöglichkeit.

Da Sphinx mit reStructuredText ein Klartextformat für die Quelltextdateien verwendet, ist damit auch die Verwendung gängiger Versionskontrollsysteme, wie z. B. Git, möglich.

Creative Commons Lizenzvertrag Dieses Werk ist lizenziert unter der Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 3.0 Österreich Lizenz (CC BY-SA 3.0 AT). Einzelne Beiträge und Medien können abweichend lizensiert sein.