[Pydev-users] [pydev - Users] RE: API Generation Tool

[SourceForge.net <no...@so...>]

Read and respond to this message at: 
https://sourceforge.net/forum/message.php?msg_id=4185039
By: dontaylor

It is very simple to set epydoc up as an external tool in Eclipse so that you
can generate an API document with a single click.  I have mine set up this way.

Go to Run -> External Tools -> External Tools ... and add a new external tool
item (say epydoc).

In the Main Location tab: enter the location of your Python interpreter Mine
is C:\Python24\python.exe.

In the Working Directory: enter the folder that contains your epydoc.py script.
Mine is C:\Python24\Scripts.

In the Arguments: enter epydoc.py -v --config ${project_loc}\epydoc.cfg

You will also need an epydoc.cfg file in the top-level of the Eclipse project
that you want to document.  You can get the details from the epydoc web-site,
but this is what the beginning of mine looks like:

[epydoc] # Epydoc section marker (required by ConfigParser)

# modules
#   The list of objects to document.  Objects can be named using
#   dotted names, module filenames, or package directory names.
#   Alases for this option include "objects" and "values".
modules: D:\DonsDocuments\eclipse3.2ws\CodeFragments\src\dwt\util.py

# output
#   The type of output that should be generated.  Should be one
#   of: html, text, latex, dvi, ps, pdf.
output: html

# target
#   The path to the output directory.  May be relative or absolute.
target: D:\DonsDocuments\eclipse3.2ws\CodeFragments\epydoc
and  so on...


Note that the target is a folder called epydoc within the project that is being
documented.

If all this works then when you press the epydoc button epydoc will run in your
Eclipse console and create a document set in the target directory.

Click on epydec/index.html and if you like you can get it to come alive inside
a tab within Eclipse (left click -> open with Web Browser).

I have used the same sort of technique to set up pycrust, doctest, nose and
wxGlade as external tools.

Don.

______________________________________________________________________
You are receiving this email because you elected to monitor this forum.
To stop monitoring this forum, login to SourceForge.net and visit: 
https://sourceforge.net/forum/unmonitor.php?forum_id=293649