[vtkusers] Where does documentation get built?

David Gobbi david.gobbi at gmail.com
Wed Dec 9 22:17:58 EST 2009


On Wed, Dec 9, 2009 at 7:53 PM, David Doria <daviddoria+vtk at gmail.com> wrote:
> I turned on "BUILD_DOCUMENTATION", but after I built VTK, I searched
> for *.html files and I didn't see any. What am I missing? I was
> expecting a Doxygen or Documentation directory (or something like
> that) to be created in my bin directory.
>
> I looked in the Makefile and I saw a DoxygenDoc target. I tried to
> build it, but I get
> error: cannot build VTK documentation without dot
>
> What does that mean? And why wasn't this error produced when I ran
> 'make' (which should build everything since 'all' is the default
> target).

The "dot" program is part of the graphviz package, it generates the
figures in the documents.  AFAIK the docs only build on Linux (or on a
unix-like environment) via the doc_makeall.sh script.  The cmake
setting just sets things up.

Generally, I always let the dashboard generate the docs and then check
them the next day, because building the docs takes a long time.  Or
for my own projects, I use a modified version of the doc_makeall
script to just generate docs for my own classes.

   David



More information about the vtkusers mailing list