[Python-Dev] Pydoc Improvements (original) (raw)

Barry Warsaw barry at python.org
Sat Jan 6 06:16:51 CET 2007

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1

On Jan 5, 2007, at 9:41 PM, Phillip J. Eby wrote:

Unless there's been a complete rewrite of epydoc since the last time I looked at it, I'd have to give a very strong -1 against epydoc; it has all the problems of pydoc, plus new ones.

I haven't read this entire thread, so I'll just chime in to say that
I've /used/ epydoc and like it quite a bit. I've even hacked on it a
little to fix a few things and it didn't seem that bad, though I
didn't do any major work on its internals. I've used both the 2.x
version and the 3.x version but I haven't used anything in the last,
I dunno, 4 or 5 months.

Note that I was using it on a heavily embedded/extended application
and it did a pretty good job of pulling docs out of C coded
docstrings. I had to patch Python a bit here and there (I think most
of those fixes are in Python 2.5) and I know that the epydoc guys
fixed a few things related to C types (e.g. such as that the tp_doc
has to document both the type and the constructor). Probably the
biggest issue that I remember was needing to invoke it
programmatically, which was an absolute requirement for us, since
none of the extension modules were importable unless epydoc was run
inside the embedded environment. I got it to work, but it was a bit
of a pain.

If you've already explained it, that's fine, but if not, could you
outline what you have against epydoc?

-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.6 (Darwin)

iQCVAwUBRZ8ww3EjvBPtnXfVAQJmnwQAnTn7W7Nri5Q+pSPmTLaIvqnmRJWDegpF HSIDY8nBcMwsST76gzpwt02GikWtyy4gujgHiAEyr4/eQyJsMcnXMptkgXixtuPz wA2pJkeo87eorPBMtOMoB9XpoyUkQTh5W/lGnR3rOinZPeiqJFEzc//DIJV+H/p7 Iqrie+FVnis= =sNBX -----END PGP SIGNATURE-----

More information about the Python-Dev mailing list