From: Matthias Maier
Date: Wed, 7 Nov 2012 15:00:25 +0000 (+0000)
Subject: Mention how to install the documentation in the readme
X-Git-Tag: v8.0.0~1079^2~302
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9c95915d8fdaf22b0bca86c1784ce89e2475dbc5;p=dealii.git
Mention how to install the documentation in the readme
git-svn-id: https://svn.dealii.org/branches/branch_cmake@27461 0785d39b-7218-0410-832d-ea1e28bc413d
---
diff --git a/deal.II/TODO.CMAKE b/deal.II/TODO.CMAKE
index d0e93d1638..f702c1452e 100644
--- a/deal.II/TODO.CMAKE
+++ b/deal.II/TODO.CMAKE
@@ -6,8 +6,6 @@ Major:
(WB: actually, no -- this is a change that should happen on
mainline once we have migrated the whole wiki)
- - The ReadME should mention how to install the documentation
-
- Write a page on how to use deal.II in external CMake projects.
(doc/development/toc.html already links to it)
(A more detailed copy of what is already standing in cmake.html)
diff --git a/deal.II/doc/readme.html b/deal.II/doc/readme.html
index 001e1d130f..3fec4fda7e 100644
--- a/deal.II/doc/readme.html
+++ b/deal.II/doc/readme.html
@@ -337,6 +337,26 @@
specifically do not want to use it, then
pass -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
+ contrib/
such as ParameterGUI,
+ specify -DDEAL_II_COMPONENT_CONTRIB=ON
.
+ Beware of the fact that parameterGUI needs
+ development packages for Qt.
+