Dokumentation 2 Go

Ich habe vor kurzem entschieden aus einem Projekt auszutreten und war gezwungen meinen Code zu dokumentieren. Ich suchte nach Tools, um mir das Leben einfacher zu machen. Da ich einen Teil des Codes bereits mit docstrings kommentiert habe, konnte ich hier mit apigen eine ansehnliche PHP-Dokumentation basteln.

Da das aber nicht alles war, was ich dokumentieren musste, bin ich zu http://sphinx-doc.org gekommen. Sphinx ist ein wunderbares Tool und ich hatte es schnell aufgesetzt und die ersten Seiten geschrieben. Tmux und Vim machten dies unfassbar schnell möglich.

Um die Dokumentation schöner zu gestalten, habe ich das ReadTheDocs-Theme benutzt und ein paar Tricks von ReadTheDocs und anderen Quellen genutzt, um die Dokumentation effektiver zu gestalten.

Das Hinzufügen neuer Seiten ist unglaublich einfach und ich habe so viel Zeit gespart, die ich sonst mühselig in LibreOffice verbracht hätte.

Obwohl ich sagen muss, dass ich bei ` und ^ die Taste zweimal drücken muss, und so Überschriften dritten Gerades etwas mühselig sind, bin ich zufrieden.