mailRe: API documentation (compilation using Scons, Epydoc, and Graphviz).


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

Header


Content

Posted by Edward d'Auvergne on October 12, 2006 - 09:56:
This is just a quick message following up on the new API documentation
pages (http://www.nmr-relax.com/api/1.2/).  I have added a target to the
Scons script to compile the API documentation (in both the 1.2 and 1.3
repository lines).  This requires the installation of both Epydoc (using
the svn repository sources by typing 'svn co
https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc', going into the
'src' directory, then typing 'python setup.py install' as root) and the
Graphviz software.  The HTML pages will be placed in the directory
'docs/api'.  To create the API documentation, within the relax base
directory type:

$ scons api_manual_html

Then look at 'docs/api/index.html'.

Edward




Related Messages


Powered by MHonArc, Updated Thu Oct 12 12:01:03 2006