[fpc-pascal] fpdoc automation help

[Graeme Geldenhuys]

On 14/09/06, Michael Van Canneyt <michael at freepascal.org> wrote:
> > I am trying to setup some script(s) or a Makefile (if I can) to handle
> > the documentation of tiOPF (open source project I work on and core of
> > our projects).
> >
> > * How does FPC handle the creation of html output using fpdoc?  From
> > what I can see it looks like everything is handled in a single
> > Makefile.fpc  (quite complex but guess it work well)
>
> I'm not sure I understand the question ? Are you referring to the
> makefile.fpc in the docs dir ?

Yes, I downloaded all fpcdocs from SubVersion. It contains *.tex,
*.xml, etc. One of those files in the root directory was Makefile.fpc
and referred to makeskel and fpdoc.  My knowledge of Makefiles are
very limited.  I will try and get my docs generated with simple bash
scripts first, then work though that Makefile in fpcdocs and see if I
can make any sense of it. :-)


> Makeskel accepts an output parameter. Make sure it is not equal to
> the input file...

So you only generate the initial *.xml files once.  After that you
always run makeskel in "update" mode with different filenames for
output.

> > * Is all the above done in some nightly event (automagically)...?
>
> No, but it could be done.

Okay, this makes me feel a little better. :-)  I will start my scripts
off manually and over time, see what processes I could automate. It
sounds the easiest to implement.

Regards,
  - Graeme -