.. _Sphinx:

**Sphinx**: Der Dokumentengenerator
########################################################################

:program:`Sphinx` ist ein Dokumentengenerator.
Er verwendet ein einfaches Textformat
namens :ref:`reStructuredText <reST-Basics>` (*"reST"*)
als *Quelltext* für für den Textinhalt
und erzeugt daraus,
je nach Bedarf,
unterschiedliche Ausgabeformate (PDF, Webseiten, E-Books u. a.).

.. graphviz::
	:caption: Sphinx kann verschiedene Ausgabeformate erstellen

	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; }

	}




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.


..
    .. graphviz::
        :caption: LaTeX verwendet einen Compiler, um die Ausgabe-PDF-Dateien zu erstellen

        digraph {

        rankdir="LR";

        "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"
            ];


        "LaTeX"  -> "LaTeX/Compiler" -> "LaTeX/Compiler/pdf" [color="#a61017"];
        }


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