From 33a156082f7c4ba8ad7cc3574fa1023664d6f186 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 3 Feb 2017 16:53:31 +0000 Subject: Modification for web site review git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/gudhi_doc_2.0.0@2059 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 6b4e7613a8cef0005ce452d6d778c604ec728090 --- src/common/doc/header.html | 209 ++++++++++++++++++++++++++++++++++++++++++--- src/common/doc/main_page.h | 15 +++- 2 files changed, 210 insertions(+), 14 deletions(-) (limited to 'src/common') diff --git a/src/common/doc/header.html b/src/common/doc/header.html index a6f3ed9c..5a155e2b 100644 --- a/src/common/doc/header.html +++ b/src/common/doc/header.html @@ -9,7 +9,7 @@ $projectname: $title $title - + @@ -25,44 +25,227 @@ $extrastylesheet - +
diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 10ca60cb..214f2bb1 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -5,7 +5,7 @@ * \section Introduction Introduction * The GUDHI library (Geometry Understanding in Higher Dimensions) is a generic open source * C++ library, with a - * cython interface, for + * Cython interface, for * Computational Topology and Topological Data Analysis * (TDA). * The GUDHI library intends to help the development of new algorithmic solutions in TDA and their transfer to @@ -236,6 +236,15 @@ make \endverbatim * To test your build, run the following command in a terminal: * \verbatim make test \endverbatim * + * \subsection documentationgeneration Documentation + * To generate the documentation, Doxygen is required. + * Run the following command in a terminal: +\verbatim +make doxygen +# Documentation will be generated in the folder YYYY-MM-DD-hh-mm-ss_GUDHI_X.Y.Z/doc/html/ +# You can customize the directory name by calling `cmake -DUSER_VERSION_DIR=/my/custom/folder` +\endverbatim + * * \section optionallibrary Optional third-party library * \subsection gmp GMP * The multi-field persistent homology algorithm requires GMP which is a free library for arbitrary-precision @@ -251,6 +260,10 @@ make \endverbatim * \subsection cgal CGAL * The \ref alpha_complex data structure, \ref bottleneck_distance, and few examples requires CGAL, which is a C++ * library which provides easy access to efficient and reliable geometric algorithms. + * + * \note There is no need to install CGAL, you can just cmake . && make CGAL (or even + * cmake -DCGAL_HEADER_ONLY=ON . for CGAL version ≥ 4.8.0), thereafter you will be able to compile + * GUDHI by calling cmake -DCGAL_DIR=/your/path/to/CGAL-X.Y .. && make * * Having CGAL version 4.4.0 or higher installed is recommended. The procedure to install this library according to * your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html -- cgit v1.2.3