Das deutsche Python-Forum

Nach einem kurzen Blick darauf war die Doku schöner als mit epydoc.

Ich wollt mal sehen wer das noch benutzt und was ihr davon haltet?

CapJo hat geschrieben:Ich wollt mal sehen wer das noch benutzt und was ihr davon haltet?

Hi CapJo!

Mich würde interessieren, wie einfach/schwer es ist, damit die Doku zu erstellen. Bei EpyDoc kann ich reStructuredText in den Docstrings verwenden. Wie sieht das mit Doxygen aus?

Ich verwende derzeit EpyDoc, da ich es nicht besser weiß und mir die einfache Dokumentation über die Docstrings gefällt. Allerdings mag ich die Ausgabe von EpyDoc nicht. Sie ist mir irgendwie zu unübersichtlich.

Wäre nett, wenn jemand, der Doxygen und EpyDoc genutzt hat, ein paar Worte darüber verlieren könnte, was er/sie bevorzugt und warum.

Das würde mich echt freuen.

lg
Gerold

Also ich hab mal ein Beispiel auf meinen Webspace gestellt.

Bei dem Beispiel handelt es sich um eine Doku von matplotlib, die ich mit doxygen erstellt habe.

http://home.arcor.de/capjo/html/index.html

Die Doku war mit wenigen Mausklicks erstellt und sieht wie ich meine recht ansprechend aus.

Ich finde auch, dass epydoc ansprechend aussieht.

Wobei, ich gebe zu, dass ich meist dir() und help() verwenden, also nicht sagen kann, mit welchem man besser arbeiten kann.

Bei Epydoc 3.0alpha geb ich dir recht, das Ganze schaut da schon besser aus als in den alten Versionen.

Von doxygen sind wir jetzt wieder weg, da Funktionen nicht mitdokumentiert werden.

Welches der beiden Programme ist eurer Meinung nach Anwender freundlicher? Ich habe vor einigen Tagen mit Doxygen herumgespielt und das empfand ich als ganz okay - wobei es da viele Schalter gibt und man sich damit vor der ersten Doku -denke ich- ziemlich damit auseinander setzen muss um ein gescheites Doxygen Konfigurationsfile zu erstellen... Wie sieht das bei Ephydoc aus??

Bzw wozu würdet ihr mir raten? Doxygen oder Ephydoc?

@antaeus:
Epydoc würde ich nehmen. Der Output sieht gut aus und wie schon Gerold gesagt hat kann man reStructuredText in den Docstrings verwenden, die Epydoc auswertet wenn im Sourcefile ``__docformat__ = "restructuredtext"`` steht.

Doxygen ist Komplizierter und nicht wirklich für Python geeignet. Außerdem hat es Probleme mit umlauten (zumindest die Version die ich gesteste hatte).

Andere Alternativen sind Pudge und PythonDoc.

lg

Also ich benutzte Doxygen und kann nicht klagen, da ich Docus im normalfall eh nicht brauch und für das bisschen was ich mache reicht es aus EpyDoc hat mir immer Fehler ausgespuckt und dann hatte ich keine Lust mehr drauf

SigMA

Mal eine Rückmeldung:

Mit Epydoc an sich bin ich sehr zufrieden. Das schöne ist, dass man sich nicht erst wie bei Doxygen stundenlang durch Manuals quälen muss, nur um festzustellen, dass Doxygen nicht so recht mit Python auskommt.

Ich hatte allerdings bei Epydoc erhebliche Schwierigkeiten bei der Installation unter Suse Linux 10.1 / 10.0. Sämtliche Installationsarten funktionierten dort leider nicht. Unter Windows läuft es aber problemlos.

A.

antaeus hat geschrieben: Ich hatte allerdings bei Epydoc erhebliche Schwierigkeiten bei der Installation unter Suse Linux 10.1 / 10.0.

Gibt es da kein fertiges RPM-Paket?

Und wenn nicht: Mit easy-install sollte es in jedem Fall funktionieren.

Ja, es gibt ein RPM-Paket. Allerdings funktioniert das nicht gescheit.

Danke für den Tipp. Das easy-install gucke ich mir nachher mal genauer an.