From a424f92e94783648422edbd639da19d92a94cf90 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Tue, 31 Jan 2017 21:35:37 +0000 Subject: Rename Rips and Alpha concept file names GUDHI version 2.0.0 git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/gudhi_doc_2.0.0@2038 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: be93fae5a69b15de05bfabe75a2d84ef606b589f --- src/common/doc/main_page.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src/common/doc') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 60c9cd07..5e8f1dd7 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -62,7 +62,7 @@ Author: Clément Maria, Pawel Dlotko, Vincent Rouvreau
- Introduced in: GUDHI 1.4.0
+ Introduced in: GUDHI 2.0.0
Copyright: GPL v3
@@ -118,7 +118,7 @@ Author: Clément Jamin
- Introduced in: GUDHI 1.4.0
+ Introduced in: GUDHI 2.0.0
Copyright: GPL v3
@@ -155,7 +155,7 @@ Author: François Godi
- Introduced in: GUDHI 1.4.0
+ Introduced in: GUDHI 2.0.0
Copyright: GPL v3
Requires: \ref cgal ≥ 4.8.0 and \ref eigen3 -- cgit v1.2.3 From 9942411c664ffbae49ed1808a9c402e9b91ca9af Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 3 Feb 2017 13:58:36 +0000 Subject: GUDHI in upper case Add link to cython doc git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/gudhi_doc_2.0.0@2058 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: dd2c37fea2d1d1972e6377d4394437edaf3f4ef7 --- src/common/doc/main_page.h | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'src/common/doc') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 5e8f1dd7..10ca60cb 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -3,7 +3,9 @@ * \image html "Gudhi_banner.png" "" width=20cm * * \section Introduction Introduction - * The Gudhi library (Geometry Understanding in Higher Dimensions) is a generic open source C++ library for + * The GUDHI library (Geometry Understanding in Higher Dimensions) is a generic open source + * C++ library, with a + * 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 @@ -211,11 +213,11 @@ */ -/*! \page installation Gudhi installation +/*! \page installation GUDHI installation * \tableofcontents - * As Gudhi is a header only library, there is no need to install the library. + * As GUDHI is a header only library, there is no need to install the library. * - * Examples of Gudhi headers inclusion can be found in \ref demos. + * Examples of GUDHI headers inclusion can be found in \ref demos. * * \section compiling Compiling * The library uses c++11 and requires Boost with version 1.48.0 or @@ -361,7 +363,7 @@ make \endverbatim * Please help us improving the quality of the GUDHI library. You may report bugs or suggestions to: * \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim * - * Gudhi is open to external contributions. If you want to join our development team, please contact us. + * GUDHI is open to external contributions. If you want to join our development team, please contact us. * */ @@ -376,7 +378,7 @@ make \endverbatim * \verbinclude biblio/how_to_cite_gudhi.bib */ -// List of Gudhi examples - Doxygen needs at least a file tag to analyse comments +// List of GUDHI examples - Doxygen needs at least a file tag to analyse comments /*! @file Examples * @example Alpha_complex/Alpha_complex_from_off.cpp * @example Alpha_complex/Alpha_complex_from_points.cpp -- cgit v1.2.3 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/Doxyfile | 2 +- src/common/doc/header.html | 209 ++++++++++++++++++++++++++++++++++++++++++--- src/common/doc/main_page.h | 15 +++- 3 files changed, 211 insertions(+), 15 deletions(-) (limited to 'src/common/doc') diff --git a/src/Doxyfile b/src/Doxyfile index a41c6d6f..36c31515 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "GUDHI" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "1.3.1" +PROJECT_NUMBER = "2.0.0" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a 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 From 330f4e26fa5b33f25c2cb8fb6dc409d8d8ff9592 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Wed, 15 Mar 2017 21:28:46 +0000 Subject: Header with correct _config.yml from Jekyll, no more beta web address git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/gudhi_doc_2.0.0@2187 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 2226ee8ee2020d68434027a57babc00da16141ae --- src/common/doc/header.html | 197 ++++----------------------------------------- 1 file changed, 14 insertions(+), 183 deletions(-) (limited to 'src/common/doc') diff --git a/src/common/doc/header.html b/src/common/doc/header.html index 5a155e2b..94e641b2 100644 --- a/src/common/doc/header.html +++ b/src/common/doc/header.html @@ -27,219 +27,50 @@ $extrastylesheet -- cgit v1.2.3