Doxygen will do Python as well as C, C++ and other languages:<br><br><a href="http://internetducttape.com/2007/03/20/automatic_documentation_python_doxygen/">http://internetducttape.com/2007/03/20/automatic_documentation_python_doxygen/</a><br>
<br><a href="http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks">http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks</a><br><br><div class="gmail_quote">On Sun, Jun 8, 2008 at 8:17 AM, David Farning <<a href="mailto:dfarning@gmail.com">dfarning@gmail.com</a>> wrote:<br>
<blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">A very early alpha of the API documentation is now up at<br>
<a href="http://www.sugarlabs.org/%7Edfarning/" target="_blank">http://www.sugarlabs.org/~dfarning/</a> .<br>
<br>
The API are generated using epydoc which has a number of pros and cons.<br>
<br>
Pros:<br>
Uses standard python docstrings- there is no commitment to epydoc in<br>
the future.<br>
Very easy.<br>
Docstrings can be extended using epytext, reStructuredText and<br>
Javadoc.<br>
<br>
Cons:<br>
The parser is more strict than the standard python parser. It catches<br>
some formatting errors that the python interrupter is able to handles.<br>
In many files the parser stopped before it reached the end of the file.<br>
I will put up a log file so developers can see what errors it is<br>
catching.<br>
<br>
Epydoc only documents python files. I haven't looked to deeply into<br>
the code but it looks like there are several c files in sugar-base and<br>
sugar-toolkit. Do we want those documented?<br>
<br>
Thanks<br>
Dfarning<br>
<br>
_______________________________________________<br>
Its.an.education.project mailing list<br>
<a href="mailto:Its.an.education.project@lists.lo-res.org">Its.an.education.project@lists.lo-res.org</a><br>
<a href="http://lists.lo-res.org/mailman/listinfo/its.an.education.project" target="_blank">http://lists.lo-res.org/mailman/listinfo/its.an.education.project</a><br>
</blockquote></div><br><br clear="all"><br>-- <br>"Always do right," said Mark Twain. "This will gratify some people and astonish the rest."