diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-08-09 16:02:23 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-08-09 16:02:23 +0000 |
| commit | 4721085696a8def22da522c32b78748765cbe006 (patch) | |
| tree | ac753477afca05abd021737adfb96f015ec0a99c /src/cython/doc/source/index.rst | |
| parent | 8ce416a795b99cb396e650b9a3512c3c23d8a9f6 (diff) | |
Modifications for sphinx documentation
latex support (still pseudo code issue)
doctest support for linux
Cmake launches make html && make doctest to test the doc
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@1427 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 58de6ec78d4368b99c9a81c9c229c4e7b075835a
Diffstat (limited to 'src/cython/doc/source/index.rst')
| -rw-r--r-- | src/cython/doc/source/index.rst | 24 |
1 files changed, 8 insertions, 16 deletions
diff --git a/src/cython/doc/source/index.rst b/src/cython/doc/source/index.rst index 2b17464a..5245d69d 100644 --- a/src/cython/doc/source/index.rst +++ b/src/cython/doc/source/index.rst @@ -3,9 +3,6 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -.. toctree:: - :maxdepth: 2 - GUDHI's documentation ##################### @@ -17,10 +14,11 @@ Introduction The Gudhi library (Geometry Understanding in Higher Dimensions) is a generic open source 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 applications. It provides -robust, efficient, flexible and easy to use implementations of -state-of-the-art algorithms and data structures. +Analysis (`TDA <https://en.wikipedia.org/wiki/Topological_data_analysis>`_). +The GUDHI library intends to help the development of new algorithmic solutions +in TDA and their transfer to applications. It provides robust, efficient, +flexible and easy to use implementations of state-of-the-art algorithms and +data structures. The current release of the GUDHI library includes: @@ -29,8 +27,8 @@ The current release of the GUDHI library includes: * Simplication of simplicial complexes by edge contraction. All data-structures are generic and several of their aspects can be -parameterized via template classes. We refer to [14] for a detailed -description of the design of the library. +parameterized via template classes. We refer to :cite:`gudhilibrary_ICMS14` +for a detailed description of the design of the library. Data structures *************** @@ -62,10 +60,4 @@ Toolbox Persistence cohomology ====================== -===================================== ===================================== ===================================== -:Author: Clément Maria :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 -===================================== ===================================== ===================================== - - - - +.. include:: persistent_cohomology_sum.rst |