Dokumentation von  Programmier Projekten zu erstellen ist für die meisten Programmierer weder angenehm noch einfach. Da liegt es recht nahe, Tools zu entwickeln die einem die Arbeit auch bei der Dokumentation erleichtern. Ich selber verwende in Python dafür sphinx.

Mit sphinx kann man automatisiert eine Webseite mit der Dokumentation der Funktionen einen Programmes erstellen. Voraussetzung dafür ist, dass man die notwendigen Funktionen mit einem guten docstring versehen hat.

Weiterlesen