[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: HTML documentation - one file per function
From: |
Søren Hauberg |
Subject: |
Re: HTML documentation - one file per function |
Date: |
Tue, 06 May 2008 06:52:15 +0200 |
man, 05 05 2008 kl. 22:05 -0400, skrev John Swensen:
> On May 3, 2008, at 12:06 PM, Søren Hauberg wrote:
>
> > lør, 03 05 2008 kl. 11:54 -0400, skrev John Swensen:
> >> Is there a way to process the docstrings so as to create one file per
> >> function? I have started work on OctaveDE again and want to make a
> >> help browser. I can simply use the existing HTML documentation, but
> >> would prefer to have it in the format of one HTML file per function.
> >> I would then try to work in cross referencing and the like. Has
> >> someone already done this before?
> >
> > You mean like the Function Reference at the Octave-Forge web site,
> > http://octave.sourceforge.net/doc/index.html ?
> >
> > Søren
> >
> As a follow-on question, who is the wizard who wrote the code to parse
> all the DOCSTRINGS for Octave and Octave-forge into this HTML format?
> Do you know if there is way to convert the texinfo stuff to docbook?
> This would make the creation of the help browser with search
> capabilities infinitely easier.
We're using 'makeinfo' for that. If you checkout Octave-Forge from SVN
you can see how we generate the HTML files by going through 'make
www' (or is it 'make doc', I can never remember...). I must warn you
that the build process of the documentation is fairly complex.
Søren