Generating the manuals from svn source

All questions about installation
Forum rules
Please read the forum usage recommendations before posting.
Post Reply
Nicoto
Posts: 5
Joined: Thu Aug 09, 2012 5:38 pm

Generating the manuals from svn source

Post by Nicoto »

Hi,

Could you publish simple instructions on how to generate the individual manuals from the sources in trunk/docs?

This is probably trivial for users familiar with Tex but, for those of us who aren't, this would be very useful in terms of being able to document the features we are implementing (and translating in English) in a manner consistent with what is already available.

Many thanks,

Nicolas
Yvan Fournier
Posts: 4082
Joined: Mon Feb 20, 2012 3:25 pm

Re: Generating the manuals from svn source

Post by Yvan Fournier »

Hello,

This is explained (very briefly) in the installation manual.

You need both pdflatex and transfig installed.

After that, in a build directory, simply run:
make pdf
to build the documentation.

For a specific documentation, you may run this command in the subdirecotory of "docs" matching that manual.
make dist
also generates the documentation, as part of the distribution tarball that it generates.

Best regards,

Yvan
Post Reply