On 5/16/07, gary thompson <garyt.and.sarahb@xxxxxxxxx> wrote:
Dear All
I have now documented all the classes and functions in multi.Processor which
covers many of the functions that other users wishing to use the frame work
need to use. However, I now need to compile them to some web pages using
epydoc. So the questions are
I haven't yet had time to check the comments to see if they match the
functions. The epydoc output should help as it should then allow you
to read it and fully understand how to use the code without seeing any
of the code.
1. what do i need to do get epydoc to work do I need to download it and
whats the minimum version i should use
Any epydoc version should be all that is necessary. This should be
installed using python distutils (by typing 'python setup.py
install'). I am using the SVN repository version (which is pre-3.0
code) as this is fairly stable and the output is much better than the
version 2 HTML. If there is a pre-3.0 release or version 3 release,
these could be used as well.
2. what formats should I produce html pdf or both also should the results of
the processing go into the repository (I guess not the person creating a tag
should run epy doc against the whole code base before submitting the tag I
guess)
The scons build system will do everything for you. If you type:
scons api_manual_html
the HTML files will be generated. None of the automatically generated
documentation should be stored in the relax SVN repository so manuals,
HTML pages, etc need to be generated if using the SVN code. This
automatical documentation can be always be generated from the tagged
code.
Cheers,
Edward
Re: How do I go about compiling epydocs