[MITgcm-devel] new "API Reference Manual" -- please take a look

[Ed Hill]

Hi folks,

I've created an initial version of an MITgcm API Reference Manual.  Its
an almost completely automated way of building the protex documentation
within the source code into a stand-alone document.  The commands are:

  $  cvs co MITgcm
  $  cd doc/api_reference/
  $  ./configure
  $  make
  $  xdvi api_main

and it currently grabs the information from pkg/generic_advdiff,
pkg/gmredi, and pkg/mnc.  It can be easily extended to the rest of the
model by uncommenting lines within:

  doc/api_reference/dir_list

Of course, to work properly, all the files in those sections must first
be formatted for protex.  And thats going to take some effort.

So please take a look at whats available and let me know if you can
think of any ways to improve it.

Ed

-- 
Edward H. Hill III, PhD
office:  MIT Dept. of EAPS;  Room 54-1424;  77 Massachusetts Ave.
            Cambridge, MA 02139-4307
email:   eh3 at mit.edu,  ed at eh3.com
URL:     http://web.mit.edu/eh3/
phone:   617-253-0098
fax:     617-253-4464
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://mitgcm.org/pipermail/mitgcm-devel/attachments/20040328/3af0c65a/attachment.sig>