ESTEL:Generate the documentation

=Subversion access= The files from which the documentation is generated are hosted in the "estel-doc" repository on the source subversion server. The full URL is http://source.ggy.bris.ac.uk/subversion/estel-doc. All ESTEL developers have access to these files. The repository is organised in a structure similar to that of ESTEL-2D or ESTEL-3D, i.e. the documentation for the latest version is in the "trunk/" and for a given stable version in "branches/RB-vxpy/" where x and y are respectively the major and minor version numbers. At the moment, only the RB-v5p6 branch exists. The v5p7 documentation is in the trunk.

=Building the documentation= Just type "make" in the relevant folder to build the PDF files. It should work if you have the relevant software installed (see the requirements below).

The Makefile is a bit special as the full paths to all commands are written. If they do not match the paths on your machine, copy the Makefile as Makefile-something and run "make -f Makefile-something</tt>" to build the documentation. Try not to modify the paths in the versionned Makefile</tt> as this would break the automatic build. Do not send Makefile-something</tt> to the repository.

Note that the PDF files are not versionned as they can simply be rebuilt. Do not add them to the repository either. Furthermore, an automatic build is done after each commit, so storing the PDF files in subversion is unnecessary.

=Automatic build= Every time, a commit is made in the estel-doc repository, the documentation is automatically rebuilt so that the links in the documentation page always point to the most up to date version of the documentation.

This is achieved using a subversion "post-commit hook", i.e. a script which is run after a commit. Obviously, if the committed code does not compile, the hook will fail. Fortunately, this does not affect the repository. You might see an error message at the the command line but the commit itself has already happened. Just type "svn update</tt>" and fix the problem.

=Requirements to build the documentation=

To be able to build the documentation, you need:


 * pdflatex</tt>
 * bibxex</tt>
 * make</tt>