From: bangerth
cmake
a second time,
possibly with different arguments.
@@ -307,6 +308,43 @@
tutorial.
+ All the documentation about the version that you downloaded and that can
+ be found at the
+ http://www.dealii.org/ domain can also be generated locally. To do
+ so, invoke cmake
in the build instructions above as follows:
+
+ + cmake -DDEAL_II_COMPONENT_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/path/install/dir ../deal.II ++ For this to succeed, you will need Perl 5.x, + doxygen + and
dot
(which is part of
+ the GraphViz
+ package) to be installed.
+
+
+
+ Upon calling make
and make install
, this will
+ install both this readme, other installation instructions, as well as the
+ manual that documents
+ all functions and classes as well as
+ the tutorial
+ of well-documented example programs (the "steps").
+
+ Note: Generating this documentation can take a really long
+ time — running doxygen through our hundreds of thousands of
+ lines of code can take 15-20 minutes even on a fast machine during which
+ you will not get any output from make
.
+
-DDEAL_II_WITH_MPI=OFF
.
-
- To build and install the documentation, specify
- -DDEAL_II_COMPONENT_DOCUMENTATION=ON
- on the command line. For generating the documentation Perl 5.x,
- doxygen
- and dot
(which is part of the GraphViz
- package) have to be installed.
-
If you wish to install projects residing under
@@ -368,7 +395,7 @@
specify -DDEAL_II_COMPONENT_CONTRIB=ON
.
Beware of the fact that parameterGUI needs
development packages for Qt.
-
+