This is a message to announce that a new set of web pages have been
added to http://nmr-relax.com. Using the program Epydoc
(http://epydoc.sourceforge.net/) I have created API documentation for
relax (using r1407 of the SVN repository path
https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc). The API
documentation can be found at http://nmr-relax.com/api/index.html.
This documentation should be a useful reference for relax developers and
a document that power users can use to create advanced scripts. It can
also be used by developers who would like to use functions and other
elements of relax within their programs. To import relax modules the
relax base directory needs to be part of the PYTHONPATH environmental
variable. The API documentation tells you what to expect when importing
the various relax modules into your Python program. For using the relax
modules within C programs, see the 'Extending and Embedding the Python
Interpreter' document located at http://docs.python.org/ext/ext.html.
Significant improvements could be made to this documentation by making
sure that all functions have docstrings and that these docstrings are
properly formatted and fully describe what the function does. For relax
functions (excluding the user functions) elements of the 'epytext'
language (http://epydoc.sourceforge.net/epytextintro.html and
http://epydoc.sourceforge.net/epytext.html) could be added to the
docstrings with hardly any formatting changes. This would significantly
improve the API documentation.
It was Andrew Perry who had the idea of the automatically generated API
documentation. I have only now implemented it because previous programs
I had tested tended to mangle the Python docstrings. The Epydoc program
solves this by using a fixed width font - hence the equations from the
docstrings are now legible in the web pages.
Edward
API documentation