From a99f1e8ceef3ccb8606ac6f5af169329db8352f4 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Wed, 29 May 2019 11:43:46 +0200 Subject: Reformat modules summary and occupy 100% of the page --- src/cython/doc/witness_complex_sum.inc | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) (limited to 'src/cython/doc/witness_complex_sum.inc') diff --git a/src/cython/doc/witness_complex_sum.inc b/src/cython/doc/witness_complex_sum.inc index a8a126a0..9dc9aef6 100644 --- a/src/cython/doc/witness_complex_sum.inc +++ b/src/cython/doc/witness_complex_sum.inc @@ -1,19 +1,17 @@ -================================================================= =================================== =================================== -:Author: Siargey Kachanovich :Introduced in: GUDHI 2.0.0 :Copyright: GPL v3 -:Euclidean version requires: CGAL :math:`\geq` 4.6.0 Eigen3 -================================================================= =================================== =================================== +.. table:: + :widths: 30 50 20 -+-------------------------------------------------------------------+----------------------------------------------------------------------+ -| .. figure:: | Witness complex :math:`Wit(W,L)` is a simplicial complex defined on | -| ../../doc/Witness_complex/Witness_complex_representation.png | two sets of points in :math:`\mathbb{R}^D`. | -| :alt: Witness complex representation | | -| :figclass: align-center | The data structure is described in | -| | :cite:`boissonnatmariasimplextreealgorithmica`. | -| | | -| Witness complex representation | | -+-------------------------------------------------------------------+----------------------------------------------------------------------+ -| :doc:`witness_complex_user` | * :doc:`witness_complex_ref` | -| | * :doc:`strong_witness_complex_ref` | -| | * :doc:`euclidean_witness_complex_ref` | -| | * :doc:`euclidean_strong_witness_complex_ref` | -+-------------------------------------------------------------------+----------------------------------------------------------------------+ + +-------------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------+ + | .. figure:: | Witness complex :math:`Wit(W,L)` is a simplicial complex defined on | :Author: Siargey Kachanovich | + | ../../doc/Witness_complex/Witness_complex_representation.png | two sets of points in :math:`\mathbb{R}^D`. | | + | :alt: Witness complex representation | | :Introduced in: GUDHI 2.0.0 | + | :figclass: align-center | The data structure is described in | | + | | :cite:`boissonnatmariasimplextreealgorithmica`. | :Copyright: GPL v3 | + | | | | + | | | :Requires: Eigen3 and CGAL :math:`\geq` 4.6.0 for Euclidean versions only | + +-------------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------+ + | :doc:`witness_complex_user` | * :doc:`witness_complex_ref` | | + | | * :doc:`strong_witness_complex_ref` | | + | | * :doc:`euclidean_witness_complex_ref` | | + | | * :doc:`euclidean_strong_witness_complex_ref` | | + +-------------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------+ -- cgit v1.2.3 From 1d53826baf9f2bccb96a7242dbabcc55d8977b19 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Mon, 3 Jun 2019 15:10:07 +0200 Subject: modify cells height for C++ doc. Use bullet lists to have the same font height on main page --- src/common/doc/main_page.md | 28 +++++++++++----------- src/cython/doc/alpha_complex_sum.inc | 2 +- src/cython/doc/bottleneck_distance_sum.inc | 4 ++-- src/cython/doc/cubical_complex_sum.inc | 2 +- src/cython/doc/nerve_gic_complex_sum.inc | 2 +- src/cython/doc/persistence_graphical_tools_sum.inc | 4 ++-- src/cython/doc/persistent_cohomology_sum.inc | 14 +++++------ src/cython/doc/rips_complex_sum.inc | 2 +- src/cython/doc/simplex_tree_sum.inc | 2 +- src/cython/doc/tangential_complex_sum.inc | 4 ++-- src/cython/doc/witness_complex_sum.inc | 10 ++++---- 11 files changed, 37 insertions(+), 37 deletions(-) (limited to 'src/cython/doc/witness_complex_sum.inc') diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index a74ebd26..e61eee81 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -23,7 +23,7 @@ - + User manual: \ref cubical_complex - Reference manual: Gudhi::cubical_complex::Bitmap_cubical_complex @@ -56,7 +56,7 @@ - + User manual: \ref alpha_complex - Reference manual: Gudhi::alpha_complex::Alpha_complex and Gudhi::alpha_complex::Alpha_complex_3d @@ -81,7 +81,7 @@ - + User manual: \ref cech_complex - Reference manual: Gudhi::cech_complex::Cech_complex @@ -107,7 +107,7 @@ - + User manual: \ref rips_complex - Reference manual: Gudhi::rips_complex::Rips_complex @@ -132,7 +132,7 @@ - + User manual: \ref witness_complex - Reference manual: Gudhi::witness_complex::SimplicialComplexForWitness @@ -159,7 +159,7 @@ - + User manual: \ref cover_complex - Reference manual: Gudhi::cover_complex::Cover_complex @@ -187,7 +187,7 @@ - + User manual: \ref simplex_tree - Reference manual: Gudhi::Simplex_tree @@ -215,7 +215,7 @@ - + User manual: \ref skbl - Reference manual: Gudhi::skeleton_blocker::Skeleton_blocker_complex @@ -240,7 +240,7 @@ - + User manual: \ref toplex_map - Reference manual: Gudhi::Toplex_map @@ -268,7 +268,7 @@ - + User manual: \ref contr @@ -300,7 +300,7 @@ - + User manual: \ref persistent_cohomology - Reference manual: Gudhi::persistent_cohomology::Persistent_cohomology @@ -330,7 +330,7 @@ - + User manual: \ref tangential_complex - Reference manual: Gudhi::tangential_complex::Tangential_complex @@ -359,7 +359,7 @@ - + User manual: \ref bottleneck_distance @@ -384,7 +384,7 @@ - + User manual: \ref Persistence_representations diff --git a/src/cython/doc/alpha_complex_sum.inc b/src/cython/doc/alpha_complex_sum.inc index 100edbbd..806988bb 100644 --- a/src/cython/doc/alpha_complex_sum.inc +++ b/src/cython/doc/alpha_complex_sum.inc @@ -16,5 +16,5 @@ | | This package requires having CGAL version 4.7 or higher (4.8.1 is | | | | advised for better performance). | | +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------+ - | :doc:`alpha_complex_user` | :doc:`alpha_complex_ref` | + | * :doc:`alpha_complex_user` | * :doc:`alpha_complex_ref` | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/bottleneck_distance_sum.inc b/src/cython/doc/bottleneck_distance_sum.inc index 4fedb744..41b9c5a3 100644 --- a/src/cython/doc/bottleneck_distance_sum.inc +++ b/src/cython/doc/bottleneck_distance_sum.inc @@ -10,5 +10,5 @@ | the longest edge | | | | | | :Requires: CGAL :math:`\geq` 4.8.0 | +-----------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------+ - | :doc:`bottleneck_distance_user` | | | - +-----------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------+ + | * :doc:`bottleneck_distance_user` | | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/cubical_complex_sum.inc b/src/cython/doc/cubical_complex_sum.inc index 6dcc1fda..6dcf8e48 100644 --- a/src/cython/doc/cubical_complex_sum.inc +++ b/src/cython/doc/cubical_complex_sum.inc @@ -9,6 +9,6 @@ | | | :Copyright: GPL v3 | | | | | +--------------------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------+ - | :doc:`cubical_complex_user` | * :doc:`cubical_complex_ref` | + | * :doc:`cubical_complex_user` | * :doc:`cubical_complex_ref` | | | * :doc:`periodic_cubical_complex_ref` | +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/nerve_gic_complex_sum.inc b/src/cython/doc/nerve_gic_complex_sum.inc index 47bf84fd..0e606fe1 100644 --- a/src/cython/doc/nerve_gic_complex_sum.inc +++ b/src/cython/doc/nerve_gic_complex_sum.inc @@ -12,5 +12,5 @@ | | | | | | | | +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------+ - | :doc:`nerve_gic_complex_user` | :doc:`nerve_gic_complex_ref` | + | * :doc:`nerve_gic_complex_user` | * :doc:`nerve_gic_complex_ref` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/persistence_graphical_tools_sum.inc b/src/cython/doc/persistence_graphical_tools_sum.inc index ee164652..b412de56 100644 --- a/src/cython/doc/persistence_graphical_tools_sum.inc +++ b/src/cython/doc/persistence_graphical_tools_sum.inc @@ -10,5 +10,5 @@ | | | | | | | :Requires: matplotlib, numpy and scipy | +-----------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+ - | :doc:`persistence_graphical_tools_user` | :doc:`persistence_graphical_tools_ref` | | - +-----------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+ + | * :doc:`persistence_graphical_tools_user` | * :doc:`persistence_graphical_tools_ref` | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/persistent_cohomology_sum.inc b/src/cython/doc/persistent_cohomology_sum.inc index 5bf1a7bf..20ca073c 100644 --- a/src/cython/doc/persistent_cohomology_sum.inc +++ b/src/cython/doc/persistent_cohomology_sum.inc @@ -17,10 +17,10 @@ | | :cite:`DBLP:conf/esa/BoissonnatDM13`. | | | | | | +-----------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+ - | :doc:`persistent_cohomology_user` | Please refer to each data structure that contains persistence | | - | | feature for reference: | | - | | | | - | | * :doc:`simplex_tree_ref` | | - | | * :doc:`cubical_complex_ref` | | - | | * :doc:`periodic_cubical_complex_ref` | | - +-----------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+ + | * :doc:`persistent_cohomology_user` | Please refer to each data structure that contains persistence | + | | feature for reference: | + | | | + | | * :doc:`simplex_tree_ref` | + | | * :doc:`cubical_complex_ref` | + | | * :doc:`periodic_cubical_complex_ref` | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/rips_complex_sum.inc b/src/cython/doc/rips_complex_sum.inc index b32b810e..e8e505e2 100644 --- a/src/cython/doc/rips_complex_sum.inc +++ b/src/cython/doc/rips_complex_sum.inc @@ -12,5 +12,5 @@ | | This complex can be built from a point cloud and a distance function, | | | | or from a distance matrix. | | +----------------------------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------+ - | :doc:`rips_complex_user` | :doc:`rips_complex_ref` | + | * :doc:`rips_complex_user` | * :doc:`rips_complex_ref` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/simplex_tree_sum.inc b/src/cython/doc/simplex_tree_sum.inc index 7e10e366..086c69d5 100644 --- a/src/cython/doc/simplex_tree_sum.inc +++ b/src/cython/doc/simplex_tree_sum.inc @@ -9,5 +9,5 @@ | | :cite:`boissonnatmariasimplextreealgorithmica` | :Copyright: GPL v3 | | | | | +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------+ - | :doc:`simplex_tree_user` | :doc:`simplex_tree_ref` | + | * :doc:`simplex_tree_user` | * :doc:`simplex_tree_ref` | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/tangential_complex_sum.inc b/src/cython/doc/tangential_complex_sum.inc index db1c5ab1..0f03ffb3 100644 --- a/src/cython/doc/tangential_complex_sum.inc +++ b/src/cython/doc/tangential_complex_sum.inc @@ -10,5 +10,5 @@ | | dimension :math:`k`. | | | | | :Requires: CGAL :math:`\geq` 4.8.0 | +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------+ - | :doc:`tangential_complex_user` | :doc:`tangential_complex_ref` | | - +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------+ + | * :doc:`tangential_complex_user` | * :doc:`tangential_complex_ref` | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/witness_complex_sum.inc b/src/cython/doc/witness_complex_sum.inc index 9dc9aef6..49577745 100644 --- a/src/cython/doc/witness_complex_sum.inc +++ b/src/cython/doc/witness_complex_sum.inc @@ -10,8 +10,8 @@ | | | | | | | :Requires: Eigen3 and CGAL :math:`\geq` 4.6.0 for Euclidean versions only | +-------------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------+ - | :doc:`witness_complex_user` | * :doc:`witness_complex_ref` | | - | | * :doc:`strong_witness_complex_ref` | | - | | * :doc:`euclidean_witness_complex_ref` | | - | | * :doc:`euclidean_strong_witness_complex_ref` | | - +-------------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------+ + | * :doc:`witness_complex_user` | * :doc:`witness_complex_ref` | + | | * :doc:`strong_witness_complex_ref` | + | | * :doc:`euclidean_witness_complex_ref` | + | | * :doc:`euclidean_strong_witness_complex_ref` | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -- cgit v1.2.3