From 5520a72287239a6b39d771df3b2511307709a4df Mon Sep 17 00:00:00 2001 From: albert-github Date: Sat, 21 May 2022 14:31:24 +0200 Subject: Documentation: Non persistent links During the link check we found some references to `#title..` in respect to links to CGAL, these links work at the moment but are, by CGAL, generated links during runtime based on the HTML `` tags. When a new paragraph or chapter is added these numbers will change and thus will the link point to the wrong place. All these items have also a more persistent reference anchor that is generated based on the `` of the section (e.g. `\section `). Therefore it is better to used the references based on the ``. --- src/Alpha_complex/doc/Intro_alpha_complex.h | 6 +++--- src/Alpha_complex/include/gudhi/Alpha_complex_3d.h | 2 +- src/Alpha_complex/utilities/alphacomplex.md | 4 ++-- src/python/doc/alpha_complex_user.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) (limited to 'src') diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h index 5ab23720..ca48ebd2 100644 --- a/src/Alpha_complex/doc/Intro_alpha_complex.h +++ b/src/Alpha_complex/doc/Intro_alpha_complex.h @@ -164,11 +164,11 @@ Table of Contents * Requires: \ref eigen ≥ 3.1.0 and \ref cgal ≥ 5.1.0. * * A weighted version for Alpha complex is available (cf. Alpha_complex). It is like a usual Alpha complex, but based - * on a CGAL regular triangulation instead + * on a CGAL regular triangulation instead * of Delaunay. * * This example builds the CGAL weighted alpha shapes from a small molecule, and initializes the alpha complex with - * it. This example is taken from CGAL 3d + * it. This example is taken from CGAL 3d * weighted alpha shapes. * * Then, it is asked to display information about the alpha complex. @@ -212,7 +212,7 @@ Table of Contents * Gudhi::alpha_complex::complexity::EXACT. * * This example builds the CGAL 3d weighted alpha shapes from a small molecule, and initializes the alpha complex with - * it. This example is taken from CGAL 3d + * it. This example is taken from CGAL 3d * weighted alpha shapes. * * Then, it is asked to display information about the alpha complex. diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h index b3dbc9bb..562ef139 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h @@ -98,7 +98,7 @@ struct Value_from_iterator { * \tparam Periodic Boolean used to set/unset the periodic version of Alpha_complex_3d. Default value is false. * * For the weighted version, weights values are explained on CGAL - * Alpha shapes 3d and + * Alpha shapes 3d and * Regular * triangulation documentation. * diff --git a/src/Alpha_complex/utilities/alphacomplex.md b/src/Alpha_complex/utilities/alphacomplex.md index 0d3c6027..1e3b8fab 100644 --- a/src/Alpha_complex/utilities/alphacomplex.md +++ b/src/Alpha_complex/utilities/alphacomplex.md @@ -64,7 +64,7 @@ N.B.: * Weights values are explained on CGAL [dD Triangulations](https://doc.cgal.org/latest/Triangulation/index.html) and -[Regular triangulation](https://doc.cgal.org/latest/Triangulation/index.html#title20) documentation. +[Regular triangulation](https://doc.cgal.org/latest/Triangulation/index.html#TriangulationSecRT) documentation. ## alpha_complex_3d_persistence ## @@ -131,6 +131,6 @@ N.B.: * `alpha_complex_3d_persistence` only accepts OFF files in dimension 3. * Filtration values are alpha square values. * Weights values are explained on CGAL -[Alpha shape](https://doc.cgal.org/latest/Alpha_shapes_3/index.html#title0) +[Alpha shape](https://doc.cgal.org/latest/Alpha_shapes_3/index.html#Alpha_shapes_3Definitions) and [Regular triangulation](https://doc.cgal.org/latest/Triangulation_3/index.html#Triangulation3secclassRegulartriangulation) documentation. diff --git a/src/python/doc/alpha_complex_user.rst b/src/python/doc/alpha_complex_user.rst index b060c86e..4082cd9d 100644 --- a/src/python/doc/alpha_complex_user.rst +++ b/src/python/doc/alpha_complex_user.rst @@ -178,11 +178,11 @@ Weighted version ^^^^^^^^^^^^^^^^ A weighted version for Alpha complex is available. It is like a usual Alpha complex, but based on a -`CGAL regular triangulation `_. +`CGAL regular triangulation `_. This example builds the weighted alpha-complex of a small molecule, where atoms have different sizes. It is taken from -`CGAL 3d weighted alpha shapes `_. +`CGAL 3d weighted alpha shapes `_. Then, it is asked to display information about the alpha complex. -- cgit v1.2.3 From 5b3f98f85c73fa7d88606bf0f1e43734af8ffa98 Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> Date: Mon, 23 May 2022 09:23:16 +0200 Subject: [skip ci] example from a small molecule Co-authored-by: Marc Glisse --- src/Alpha_complex/doc/Intro_alpha_complex.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h index ca48ebd2..d06a582c 100644 --- a/src/Alpha_complex/doc/Intro_alpha_complex.h +++ b/src/Alpha_complex/doc/Intro_alpha_complex.h @@ -168,7 +168,7 @@ Table of Contents * of Delaunay. * * This example builds the CGAL weighted alpha shapes from a small molecule, and initializes the alpha complex with - * it. This example is taken from CGAL 3d + * it. This example is taken from CGAL 3d * weighted alpha shapes. * * Then, it is asked to display information about the alpha complex. -- cgit v1.2.3 From b1a5176862ae5e3c0b52bd5d0770b0945ce85853 Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> Date: Mon, 23 May 2022 09:23:28 +0200 Subject: [skip ci] example from a small molecule --- src/Alpha_complex/doc/Intro_alpha_complex.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h index d06a582c..7f14f423 100644 --- a/src/Alpha_complex/doc/Intro_alpha_complex.h +++ b/src/Alpha_complex/doc/Intro_alpha_complex.h @@ -212,7 +212,7 @@ Table of Contents * Gudhi::alpha_complex::complexity::EXACT. * * This example builds the CGAL 3d weighted alpha shapes from a small molecule, and initializes the alpha complex with - * it. This example is taken from CGAL 3d + * it. This example is taken from CGAL 3d * weighted alpha shapes. * * Then, it is asked to display information about the alpha complex. -- cgit v1.2.3 From a3a3749ac3a1d960d99ad7ce0d7f1463365ee657 Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> Date: Mon, 23 May 2022 09:23:41 +0200 Subject: [skip ci] example from a small molecule --- src/python/doc/alpha_complex_user.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/python/doc/alpha_complex_user.rst b/src/python/doc/alpha_complex_user.rst index 4082cd9d..9e67d38a 100644 --- a/src/python/doc/alpha_complex_user.rst +++ b/src/python/doc/alpha_complex_user.rst @@ -182,7 +182,7 @@ A weighted version for Alpha complex is available. It is like a usual Alpha comp This example builds the weighted alpha-complex of a small molecule, where atoms have different sizes. It is taken from -`CGAL 3d weighted alpha shapes `_. +`CGAL 3d weighted alpha shapes `_. Then, it is asked to display information about the alpha complex. -- cgit v1.2.3