From 720d6822a9436f46631ec6e07d33d4581849b6e8 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Tue, 2 Jun 2020 22:05:59 +0200 Subject: Fix sphinx warning and link inside the doc --- src/python/doc/rips_complex_ref.rst | 4 ---- src/python/doc/rips_complex_user.rst | 6 ++---- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/src/python/doc/rips_complex_ref.rst b/src/python/doc/rips_complex_ref.rst index 2aa6b268..f0582d5c 100644 --- a/src/python/doc/rips_complex_ref.rst +++ b/src/python/doc/rips_complex_ref.rst @@ -13,8 +13,6 @@ Rips complex reference manual .. automethod:: gudhi.RipsComplex.__init__ -.. _weighted-rips-complex-reference-manual: - ====================================== Weighted Rips complex reference manual ====================================== @@ -26,8 +24,6 @@ Weighted Rips complex reference manual .. automethod:: gudhi.weighted_rips_complex.WeightedRipsComplex.__init__ -.. _dtm-rips-complex-reference-manual: - ================================= DTM Rips complex reference manual ================================= diff --git a/src/python/doc/rips_complex_user.rst b/src/python/doc/rips_complex_user.rst index dd2f2cc0..868ef0e7 100644 --- a/src/python/doc/rips_complex_user.rst +++ b/src/python/doc/rips_complex_user.rst @@ -378,7 +378,7 @@ Example from a point cloud combined with DistanceToMeasure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Combining with DistanceToMeasure, one can compute the DTM-filtration of a point set, as in `this notebook `_. -Remark that `DTMRipsComplex `_ class provides exactly this function. +Remark that `DTM Rips Complex (user manual) `_ class provides exactly this function. .. testcode:: @@ -400,12 +400,10 @@ The output is: [(0, (3.1622776601683795, inf)), (0, (3.1622776601683795, 5.39834563766817)), (0, (3.1622776601683795, 5.39834563766817))] -.. _dtm-rips-complex: - DTM Rips Complex ---------------- -`DTMRipsComplex `_ builds a simplicial complex from a point set or a full distance matrix (in the form of ndarray), as described in the above example. +`DTMRipsComplex (reference manual) `_ builds a simplicial complex from a point set or a full distance matrix (in the form of ndarray), as described in the above example. This class constructs a weighted Rips complex giving larger weights to outliers, which reduces their impact on the persistence diagram. See `this notebook `_ for some experiments. .. testcode:: -- cgit v1.2.3 From 83db295e36db019172cdcf3a490c500a880c862f Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Wed, 3 Jun 2020 07:36:27 +0200 Subject: doc review: use :class: to link to the ref manual, rollback link to the user manual --- src/python/doc/rips_complex_user.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/python/doc/rips_complex_user.rst b/src/python/doc/rips_complex_user.rst index 868ef0e7..6048cc4e 100644 --- a/src/python/doc/rips_complex_user.rst +++ b/src/python/doc/rips_complex_user.rst @@ -378,7 +378,7 @@ Example from a point cloud combined with DistanceToMeasure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Combining with DistanceToMeasure, one can compute the DTM-filtration of a point set, as in `this notebook `_. -Remark that `DTM Rips Complex (user manual) `_ class provides exactly this function. +Remark that `DTMRipsComplex `_ class provides exactly this function. .. testcode:: @@ -403,7 +403,7 @@ The output is: DTM Rips Complex ---------------- -`DTMRipsComplex (reference manual) `_ builds a simplicial complex from a point set or a full distance matrix (in the form of ndarray), as described in the above example. +:class:`~gudhi.dtm_rips_complex.DTMRipsComplex` builds a simplicial complex from a point set or a full distance matrix (in the form of ndarray), as described in the above example. This class constructs a weighted Rips complex giving larger weights to outliers, which reduces their impact on the persistence diagram. See `this notebook `_ for some experiments. .. testcode:: -- cgit v1.2.3