mailRe: float.py


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by Edward d'Auvergne on October 16, 2006 - 10:09:
Its no problem to do the cosmetic stuff  and I will put the code into
the epydoc format when i get a chance (thats fairly easy it looks like
javadoc)

You don't need to format your docstrings into the epydoc format for the API documentation (http://nmr-relax.com/api/). Plain text is fine. Epydoc will accept a number of docstring formats including plaintext, epytext, Javadoc, and ReStructuredText. If you docstrings are formatted in Javadoc or are close to javadoc, have a look at the page http://epydoc.sourceforge.net/othermarkup.html for more details. If you set the variable '__docformat__' just after the docstring, you can pick any of these formats and epydoc will format the HTML accordingly.

Edward



Related Messages


Powered by MHonArc, Updated Mon Oct 16 11:00:36 2006