summaryrefslogtreecommitdiff
path: root/src/python/doc
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-02-26 22:03:18 +0100
committerMarc Glisse <marc.glisse@inria.fr>2020-02-26 22:03:18 +0100
commit07c7e5841c961869b927875bbca91d10287f9fab (patch)
treed245deef34d9a20a6eef36a1747276e445d530e5 /src/python/doc
parent5ffe71dab84d9cbcaccd55324a73018b6915e886 (diff)
Initial commit of tomato
Diffstat (limited to 'src/python/doc')
-rw-r--r--src/python/doc/clustering.inc12
-rw-r--r--src/python/doc/clustering.rst11
-rw-r--r--src/python/doc/index.rst5
3 files changed, 28 insertions, 0 deletions
diff --git a/src/python/doc/clustering.inc b/src/python/doc/clustering.inc
new file mode 100644
index 00000000..b845e1a7
--- /dev/null
+++ b/src/python/doc/clustering.inc
@@ -0,0 +1,12 @@
+.. table::
+ :widths: 30 50 20
+
+ +-------------------------+------------------------------------------------------------------------+---------------------------------+
+ | | Clustering tools. | :Author: Marc Glisse |
+ | | | |
+ | | | :Introduced in: GUDHI 3.2.0 |
+ | | | |
+ | | | :Copyright: MIT |
+ +-------------------------+------------------------------------------------------------------------+---------------------------------+
+ | * :doc:`clustering` |
+ +-------------------------+----------------------------------------------------------------------------------------------------------+
diff --git a/src/python/doc/clustering.rst b/src/python/doc/clustering.rst
new file mode 100644
index 00000000..e16bce4f
--- /dev/null
+++ b/src/python/doc/clustering.rst
@@ -0,0 +1,11 @@
+:orphan:
+
+.. To get rid of WARNING: document isn't included in any toctree
+
+=================
+Clustering manual
+=================
+
+.. autoclass:: gudhi.clustering.tomato.Tomato
+ :members:
+ :special-members: __init__
diff --git a/src/python/doc/index.rst b/src/python/doc/index.rst
index 3387a64f..ddadb202 100644
--- a/src/python/doc/index.rst
+++ b/src/python/doc/index.rst
@@ -86,6 +86,11 @@ Point cloud utilities
.. include:: point_cloud_sum.inc
+Clustering
+**********
+
+.. include:: clustering.inc
+
Bibliography
************