aboutsummaryrefslogtreecommitdiff
path: root/Carpet/doxygen/README
blob: c426f7d301fdab87e3af22378121e489aa3d0057 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
This directory contains, in the CVS or darcs repository, the Doxygen
configuration file.  The generated documentation will also be placed
here, but should not go into the repository.

Create the Doxygen configuration by running the command

        doxygen doxygen/Doxyfile

from one directory up, i.e., from the Carpet arrangement directory.
This will create html documentation in a subdirectory html, and latex
documentation in a subdirectory latex.  The latex subdirectory
contains a makefile that creates pdf from the latex sources.

-erik