summaryrefslogtreecommitdiff
path: root/src/python/doc/index.rst
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2019-09-10 11:23:03 +0200
committerGitHub <noreply@github.com>2019-09-10 11:23:03 +0200
commit9d5ddcac38d43c9df813c0ca4a37b7dc48c68913 (patch)
treed6e893623f5c621a2bd356bc053d7c0d71aa9234 /src/python/doc/index.rst
parentf510a7e607b46ba8cc118cd787ff9b0b8bff091f (diff)
parent2a313b489f1412f7e9d65681cea622d88828cba3 (diff)
Merge pull request #91 from VincentRouvreau/split_gudhi_python_in_modules
Split gudhi python in modules
Diffstat (limited to 'src/python/doc/index.rst')
-rw-r--r--src/python/doc/index.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/src/python/doc/index.rst b/src/python/doc/index.rst
new file mode 100644
index 00000000..e379bc23
--- /dev/null
+++ b/src/python/doc/index.rst
@@ -0,0 +1,86 @@
+GUDHI Python module documentation
+#################################
+
+.. figure::
+ ../../doc/common/Gudhi_banner.png
+ :alt: Gudhi banner
+ :figclass: align-center
+
+Complexes
+*********
+
+Cubical complexes
+=================
+
+.. include:: cubical_complex_sum.inc
+
+Simplicial complexes
+====================
+
+Alpha complex
+-------------
+
+.. include:: alpha_complex_sum.inc
+
+Rips complex
+-------------
+
+.. include:: rips_complex_sum.inc
+
+Witness complex
+---------------
+
+.. include:: witness_complex_sum.inc
+
+Cover complexes
+===============
+
+.. include:: nerve_gic_complex_sum.inc
+
+Data structures and basic operations
+************************************
+
+Data structures
+===============
+
+Simplex tree
+------------
+
+.. include:: simplex_tree_sum.inc
+
+Topological descriptors computation
+***********************************
+
+Persistence cohomology
+======================
+
+.. include:: persistent_cohomology_sum.inc
+
+Manifold reconstruction
+***********************
+
+Tangential complex
+==================
+
+.. include:: tangential_complex_sum.inc
+
+
+Topological descriptors tools
+*****************************
+
+Bottleneck distance
+===================
+
+.. include:: bottleneck_distance_sum.inc
+
+Persistence graphical tools
+===========================
+
+.. include:: persistence_graphical_tools_sum.inc
+
+Bibliography
+************
+
+.. bibliography:: ../../biblio/bibliography.bib
+ :filter: docnames
+ :style: unsrt