Re: building documention

[John W. Eaton]

On 31-May-2001, Gerrit <address@hidden> wrote:

| I've extracting the all info lines together with Copyright statement of all
| m-files in one text file. I basicly added a ruler between the different
| files, included filename and got rid of the GNU statements. This file is now
| half a Meg big, so it cannot be posted in this mailing list. I could send
| anyone interested a copy (or a internetlink). zipped 90 Mb.
| 
| This file includes only the 550 m-files that that are distributed in the
| Win32 compilation available at http://matlinks.sourceforge.net
| 
| Formatting this into a manual is another question that I gladly leave open
| ;-)

Take a look at the way the Octave 2.1.x build process does it.

The manual sources (.txi files) contain lines like this:

@DOCSTRING(foo)

which are replaced with the docstring information extracted for
function "foo" (assumed to already be marked up with Texinfo
commands).  The resulting file can then be processed with TeX,
texi2html, makeinfo, or other tools to produce output in a variety of
formats suitable for printing or online use.

The scripts/programs that do the extracting/munging are

  scripts/gethelp.cc
  scripts/mkdoc
  doc/interpreter/munge-texi.cc
  src/mkdocs
  src/mkgendoc

You'll have to look at the Makefiles to see how they are used.

jwe



-------------------------------------------------------------
Octave is freely available under the terms of the GNU GPL.

Octave's home on the web:  http://www.octave.org
How to fund new projects:  http://www.octave.org/funding.html
Subscription information:  http://www.octave.org/archive.html
-------------------------------------------------------------