#322 Epydoc incompatible with Docutils 0.6

v3.0
open
nobody
None
5
2009-11-10
2009-11-10
Anonymous
No

Epydoc has some problems with Docutils 0.6. See http://thread.gmane.org/gmane.text.docutils.devel/4888 for some details.

Discussion

  • Thomas Hille
    Thomas Hille
    2009-12-21

    Epydoc has not 'some' problems, it simply refuses to work completely with docutils 0.6. It crashes on every project I'm currently working on.

     
  • This is filed as Debian bug #561793:

    http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=561793

    The Debian bug report includes a patch that was originally developed by Thomas Hille. This patch (uploaded as Debian version 3.0.1-4) fixes the known problems related to the Debian package, although it's hard to know whether it's a proper fix or just a band-aid.

     
  • Gentoo is using an adjusted version of a patch by Engelbert Gruber from the mailing list mentioned in the original posting: https://bugs.gentoo.org/attachment.cgi?id=210118

    To me this patch seems superior to the one used by Debian, because it has smaller footprint, uses accessor methods instead of tweaking around with possibly nonexistent member variables, and on the whole seems more likely to yield intended results. All of this I say with hardly a look at the sources around the patch, so I might be wrong.

     
  • Thomas Hille
    Thomas Hille
    2009-12-31

    The gentoo patch does effectively the same as mine as far as I can tell, because if the 'child' has no data attribute it also means the 'astext()' method should return an empty string. I have not looked through the complete source though, ther might be some caveats I have missed.

    BTW the footprint is the same if you account for python's indentation, mine just adds a line (and indents the rest one level), while the gentoo one changes 2 and adds 1.

    But overall the patches are very similar, it's just a matter of style preference.

    - Thomas Hille

     
  • Epydoc also seems to be incompatible with docutils 0.7, with the same exception. Please fix this, as at this moment "easy_install docutils epydoc" gives an unusable installation.