Generate API docs using Epydoc

[GoogleCodeExporter]

As for r55, we have (beautiful) hand-made technical.xml file, that contains
some API docs. It's difficult to keep it synchronized with the source code,
so I suggest to use Epydoc utility <http://epydoc.sourceforge.net/> for
generating API docs automatically. I've tried to generate docs for r55 --
they look quite nice, but *some adaptation of source comments is needed
anyway*. All I need to get the docs is to run:

$ epydoc.py -o doc/epydoc src/pycoon

Richard, try it on your Linux box.

Original issue reported on code.google.com by anrien...@gmail.com on 12 Nov 2006 at 8:55

[GoogleCodeExporter]

Cool. I've just had a go at this and the results look really professional!

There do seem to be some odd things (which I'm sure a bit of googling will 
supply 
answers to) like it seems to ignore the parts of my function doc strings 
following 
line spaces...)

It will mean that I'll have to transfer the documentation from the 
technical.xml 
file into the source code and learn how to do some more interesting things with 
epydoc, but I guess its worth it...

Original comment by pyc...@gmail.com on 15 Nov 2006 at 11:15

[GoogleCodeExporter]

Currently we do generate API documentation using Epydoc. We don't store it in
Subversion due to space limits (100 MB) on Google Code Project Hosting.

Original comment by anrien...@gmail.com on 26 Feb 2007 at 6:34

• Changed state: Fixed