epydoc/docutils Problem

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Antworten
henning
User
Beiträge: 274
Registriert: Dienstag 26. Juli 2005, 18:37

Samstag 4. Februar 2006, 17:03

Moin, ich wollte mir jetzt endlich mal angewöhnen, auch meine Python-docstring in restructuredText zu schreiben und musste zu meinem bedauern feststellen, dass pydoc diese gar nicht besonders berücksichtigt.

Also kurzerhand epydoc installiert, der allerdings allergisch auf ReST zu reagieren scheint:

Code: Alles auswählen

- Error: Internal error: 'int' object is not callable
Krieg ich immer für die Zeilen, in denen die Modul-Docstrings anfangen, wenn __docformat__ = "restructuredtext" gesetzt ist.
Ausserdem werden die docstrings nicht wirklich gerendert (halt nur als text eingefügt)

Hier ein paar Versionsnummern:

Code: Alles auswählen

~$ epydoc -V
Epydoc version 2.1
~$ python -V
Python 2.4.2
~$ apt-cache policy python2.4-docutils
python2.4-docutils:
  Installiert:0.3.9-0.1
(...)
Auch das verwenden von python2.3 anstelle von 2.4 schafft keine Abhilfe, jetzt wüsste ich gerne, ob man dieses Problem beheben kann, oder ob es eine Alternative für mich gibt.
(Zielformat ist HTML)
BlackJack

Sonntag 5. Februar 2006, 01:24

Es gibt auf der Projektseite bei SourceForge einen Patch der das Problem beheben soll. Habe ich noch nicht selbst ausprobiert.

`epydoc` scheint leider tot zu sein, der Entwickler rührt sich schon seit einiger Zeit nicht mehr.

pudge macht einen netten Eindruck, ist aber noch in der alpha-Phase. Was mir daran besonders gut gefällt ist die Möglichkeit beliebige ReST-Dokumente einzubinden um ausserhalb der docstrings Dokumentation zu schreiben, zum Beispiel einen Architektur-Überblick für ein Package oder Tutorials, FAQs usw.
henning
User
Beiträge: 274
Registriert: Dienstag 26. Juli 2005, 18:37

Sonntag 5. Februar 2006, 10:21

Danke, dieses pudge hört sich ja sehr vielversprechend an, das werde ich mir mal angucken!
Antworten