From b487c8bf2bb87566a73d607f83785f2497866684 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Tue, 9 May 2017 13:07:56 +0000 Subject: Doc issue git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@2407 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 59aa4cbeef583b93f5e0e4416a4cd2903643d8f0 --- src/Persistent_cohomology/example/README | 2 +- src/common/doc/main_page.h | 5 ++--- src/cython/doc/index.rst | 10 +++++----- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/src/Persistent_cohomology/example/README b/src/Persistent_cohomology/example/README index 2ac79398..794b94ae 100644 --- a/src/Persistent_cohomology/example/README +++ b/src/Persistent_cohomology/example/README @@ -121,7 +121,7 @@ N.B.: - alpha_complex_persistence accepts OFF files in d-Dimension. 3) 3D periodic special case --------------------------- -./periodic_alpha_complex_3d_persistence ../../data/points/grid_10_10_10_in_0_1.off 3 1.0 +./periodic_alpha_complex_3d_persistence ../../data/points/grid_10_10_10_in_0_1.off ../../data/points/iso_cuboid_3_in_0_1.txt 3 1.0 output: Periodic Delaunay computed. diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 125ef47b..bd4615f5 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -1,11 +1,10 @@ -/*! \mainpage +/*! \mainpage The C++ library * \tableofcontents * \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, with a - * Python interface, for + * C++ library 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 diff --git a/src/cython/doc/index.rst b/src/cython/doc/index.rst index 4f5acfd4..f6d10567 100644 --- a/src/cython/doc/index.rst +++ b/src/cython/doc/index.rst @@ -1,5 +1,5 @@ -GUDHI documentation -################### +GUDHI Python module documentation +################################# .. image:: img/Gudhi_banner.png :align: center @@ -7,9 +7,9 @@ GUDHI documentation Introduction ************ -The Gudhi library (Geometry Understanding in Higher Dimensions) is a generic -open source `C++ library `_, with a -`Python interface `_, for +The Python interface for the Gudhi library (Geometry Understanding in Higher +Dimensions) is a generic open source +`Python module `_, for Computational Topology and Topological Data Analysis (`TDA `_). The GUDHI library intends to help the development of new algorithmic solutions -- cgit v1.2.3