Optimize Doxygen build
commitad3270b44f69118f8e657596dc82504225a50719
authorTeemu Murtola <teemu.murtola@gmail.com>
Sat, 1 Feb 2014 04:57:34 +0000 (1 06:57 +0200)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Mon, 3 Feb 2014 01:04:19 +0000 (3 02:04 +0100)
treed348d6d7700912c046cbbb0a78201d7f07a1e1bb
parent1df1ceb291138926b294ac19b60f4c387478f07d
Optimize Doxygen build

- Don't include verbatim headers in the documentation.  In addition to
  marginally reducing disk usage and processing time, this hides
  undocumented files from the file list, making it look better.
- Generate svg instead of png images. This reduces the disk usage of the
  build output by ~30%.  Change HTML file extension to .xhtml per
  Doxygen documentation to support svg images on IE.
- Add a CMake option GMX_COMPACT_DOXYGEN that disables most
  automatically generated graphs.  Compared to the original
  png-containing build, this reduces the disk usage by ~70%.

Times it takes to generate the documentation are reduced comparably.
Also enable generating multiple DOT graphs in one run, significantly
speeding up the build.  graphviz versions that don't support this are
ancient.

Change-Id: I5dd91779a8086025d9f0c0e477ce300d6a75a580
doxygen/CMakeLists.txt
doxygen/Doxyfile-common.cmakein
doxygen/Doxyfile-compact [new file with mode: 0644]
doxygen/index.html
doxygen/mainpage.md