From fb586972e35c8b6149cf556a754bdbe1c664725b Mon Sep 17 00:00:00 2001
From: Wolfgang Bangerth
+ As usual, you can pass
cmake -DDEAL_II_COMPONENT_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/path/install/dir ../deal.II
+ make documentation
+ make install
-jN
to make
+ in order to use more than one processor.
For this to succeed, you will need Perl 5.x,
doxygen and dot
(which is part of the GraphViz package) to be installed.
-DDEAL_II_DOXYGEN_USE_ONLINE_MATHJAX=OFF
CMake will try to find a local installation of MathJax scripts, otherwise the online version of the scripts will be used in the documentation.
- 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
.
--
2.39.5