Hi,
I am at Pycon 2010 this week and I sat through a tutorial for sphinx
which is a documentation system that goes above and beyond what
reStructuredTex does. This is the same system that the python library
reference uses.
It works by using introspection. So however your class and functions
are defined it will automatically document them. As a bonus if you
have included text in a doc string it will add that for the function.
It will even document todo lists. I think this would be a great
resource for cobbler developers. I would suggest these files be in
the cobbler repo so everyone can document new classes and add helpful
text or code snippets to demonstrate how things are supposed to be
used. I am no expert at this documentation syntax but have created a
sample cobbler api reference in about 3 hours. Its even got a search
function for looking up functions and such. If you click on the
source link on the left nav you can see what the sphinx syntax is
like. Check it out.
http://www.logicminds.biz/cobblerdocs
http://sphinx.pocoo.org/
Corey