Commit Graph

11 Commits

Author SHA1 Message Date
Roland Kaufmann
4d00754e01 Move stylesheets into Documentation/ folder
The Doxyfile is still in the root directory because this is more like
a configuration file, and also its presence will be a cue to some
users that Doxygen is possible to run on the project.
2013-02-11 23:08:27 +01:00
Roland Kaufmann
694f98b54a Reinstate figure directory for documentation
The directory must be specified with full path to refer to the source
directory. The images will not be referred to by this path, but rather
copied to the output directory (as of Doxygen 1.7.6.1 at least), unlike
the stylesheet (consistency is so last decade).
2013-02-11 23:06:38 +01:00
Tor Harald Sandve
8ea72fcec1 Use relative path to link style.css correctly from website
If an absolute path is specified, this will be embedded into the
generated files, which is of course not correct when put on another
host.
2013-02-11 23:06:38 +01:00
Atgeirr Flø Rasmussen
d8c045cdfd Exclude embedded TinyXML library from doc generation. 2013-02-11 23:06:36 +01:00
Roland Kaufmann
eaac6631e2 Disable generation of LaTeX/PDF documentation
Class listings are impractical in PDF format. Instead, the tutorial
alone could perhaps be published in PDF.
2013-02-11 22:37:59 +01:00
Roland Kaufmann
8ce114df89 Make documentation installable
If `make install` is run, the document is included if and only if
it has already been built. If `make install-html` is run, then the
documentation is always generated first, before installation. To
build the documentation separately from installation use `make doc`
2013-02-11 22:37:57 +01:00
Roland Kaufmann
22dee20c9f Don't expect human interaction in build
If the build fails, we want the error logged to a file, not that the
build hangs on a terminal (which may even not exist!)
2013-02-11 22:37:57 +01:00
Roland Kaufmann
bc327eed1e Disable tons of warnings in building documentation
The volume of warnings generated for the documentation completely drowns
out anything else useful. Until we have fixed more of the comments, this
should be disabled as to focus on problems with the code instead.
2013-02-11 22:37:56 +01:00
Roland Kaufmann
ffe00180a6 Generate documentation in a custom target
The targets are named after the similar targets when using Autotools.
2013-02-11 22:37:56 +01:00
Roland Kaufmann
8b3b753662 Use paths from build-spec. instead of relative paths 2013-02-11 22:37:56 +01:00
Roland Kaufmann
1cb8f4b0e7 Generate customized Doxyfile for each build 2013-02-11 22:37:56 +01:00