Dokumentieren

Sphinx ist ein Dokumentationswerkzeug, das reStructuredText, eine einfache Auszeichnungssprache, in HTML oder auch PDF, EPub und man pages umwandelt. Den Quellcode dieser Seite könnt ihr euch anschauen unter Sources. Ursprünglich wurde Sphinx für die Dokumentation von Python entwickelt und wird heute auch in fast allen Python-Projekten verwendet, u.a. für NumPy und SciPy, Matplotlib, Pandas und SQLAlchemy.

Zur Verbreitung von Sphinx unter den Python-Entwicklern dürfte auch beigetragen haben, dass Sphinx autodoc-Feature auch aus Python Docstrings Dokumentationen erzeugen kann.

Auch in Projekten außerhalb der Python-Community wird Sphinx verwendet, z.B. für die Dokumentation des Linux Kernels: Kernel documentation update.

Um die Erstellung von Dokumentationen weiter zu vereinfachen, wurde Read the Docs entwickelt. Read the Docs vereinfacht das Erstellen und Veröffentlichen von Dokumentation nach jedem Commit.