Merge pull request #1062 from julien-tierny/doc

[doc] Fix broken example links
topology-tool-kit · Sep 17, 2024 · 483a214 · 483a214
2 parents 816e833 + 4ed8bed
commit 483a214
Show file tree

Hide file tree

Showing 28 changed files with 100 additions and 33 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -242,6 +242,8 @@ jobs:
  # remove buggy example
  # related issue: https://github.com/topology-tool-kit/ttk/issues/1055
  rm python/nestedTrackingFromOverlap.py
+ # tmp removal of mpi example
+ rm python/mpiExample.py
  # remove examples which fill up the memory
  rm python/topologicalOptimization_darkSky.py
  python3 -u python/run.py
@@ -398,6 +400,8 @@ jobs:
  # remove buggy example
  # related issue: https://github.com/topology-tool-kit/ttk/issues/1055
  rm python/nestedTrackingFromOverlap.py
+ # tmp removal of mpi example
+ rm python/mpiExample.py
  # remove examples which fill up the memory
  rm python/topologicalOptimization_darkSky.py
  pvpython -u python/run.py
@@ -582,6 +586,8 @@ jobs:
  set PV_PLUGIN_PATH=%TTK_DIR%\bin\plugins
  cd ttk-data
  rm python/nestedTrackingFromOverlap.py
+ # tmp removal of mpi example
+ rm python/mpiExample.py
  # remove examples which fill up the memory
  rm python/topologicalOptimization_darkSky.py
  pvpython.exe -u python\run.py

diff --git a/core/base/arrayPreconditioning/ArrayPreconditioning.h b/core/base/arrayPreconditioning/ArrayPreconditioning.h
@@ -9,7 +9,10 @@
 /// In distributed, using GlobalOrder set to True, this module will compute a
 /// global order, otherwise each process will locally compute its order.
 ///
-
+/// \b Online \b examples:\n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 #pragma once
 
 // ttk common includes

diff --git a/core/base/dimensionReduction/DimensionReduction.h b/core/base/dimensionReduction/DimensionReduction.h
@@ -22,7 +22,7 @@
 /// href="https://topology-tool-kit.github.io/examples/clusteringKelvinHelmholtzInstabilities/">
 /// Clustering Kelvin Helmholtz Instabilities example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions//">Karhunen-Love
+/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions/">Karhunen-Love
 /// Digits 64-Dimensions example</a> \n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/mergeTreeClustering/">Merge

diff --git a/core/base/integralLines/IntegralLines.h b/core/base/integralLines/IntegralLines.h
@@ -12,6 +12,11 @@
 /// lines along the edges of the input triangulation.
 ///
 /// \sa ttkIntegralLines.cpp %for a usage example.
+///
+/// \b Online \b examples:\n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 
 #pragma once
 

diff --git a/core/base/morseSmaleComplex/MorseSmaleComplex.h b/core/base/morseSmaleComplex/MorseSmaleComplex.h
@@ -70,7 +70,7 @@
 /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 /// Puzzle example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky</a>\n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/tribute/">Tribute

diff --git a/core/base/persistenceDiagram/PersistenceDiagram.h b/core/base/persistenceDiagram/PersistenceDiagram.h
@@ -91,7 +91,7 @@
 /// href="https://topology-tool-kit.github.io/examples/interactionSites/">
 /// Interaction sites</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions//">Karhunen-Love
+/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions/">Karhunen-Love
 /// Digits 64-Dimensions example</a> \n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/morsePersistence/">Morse
@@ -130,13 +130,13 @@
 /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 /// Puzzle example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological
 /// Optimization for Torus Repair example</a>\n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/tribute/">Tribute

diff --git a/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h b/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h
@@ -38,6 +38,9 @@
 /// href="https://topology-tool-kit.github.io/examples/interactionSites/">
 /// Interaction sites</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/uncertainStartingVortex/">
 /// Uncertain Starting Vortex example</a> \n
 

diff --git a/core/base/scalarFieldSmoother/ScalarFieldSmoother.h b/core/base/scalarFieldSmoother/ScalarFieldSmoother.h
@@ -42,13 +42,16 @@
 /// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale
 /// segmentation example</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
 /// Diagram Principal Geodesic Analysis example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 
 #pragma once

diff --git a/core/base/signedDistanceField/SignedDistanceField.h b/core/base/signedDistanceField/SignedDistanceField.h
@@ -28,10 +28,10 @@
 ///
 /// \b Online \b examples: \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological
 /// Optimization for Torus Repair example</a>\n
 
 #pragma once

diff --git a/core/base/topologicalSimplification/TopologicalSimplification.h b/core/base/topologicalSimplification/TopologicalSimplification.h
@@ -88,13 +88,13 @@
 /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 /// Puzzle example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological
 /// Optimization for Torus Repair example</a>\n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/tribute/">Tribute

diff --git a/core/vtk/ttkArrayPreconditioning/ttkArrayPreconditioning.h b/core/vtk/ttkArrayPreconditioning/ttkArrayPreconditioning.h
@@ -16,6 +16,11 @@
 ///
 /// \sa ttk::ttkArrayPreconditioning
 /// \sa ttkAlgorithm
+///
+/// \b Online \b examples:\n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 
 #pragma once
 

diff --git a/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h b/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h
@@ -46,10 +46,13 @@
 /// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale
 /// segmentation example</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
 /// Diagram Principal Geodesic Analysis example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 ///
 

diff --git a/core/vtk/ttkIntegralLines/ttkIntegralLines.h b/core/vtk/ttkIntegralLines/ttkIntegralLines.h
@@ -57,6 +57,11 @@
 ///
 /// \sa ttk::IntegralLines
 /// \sa vtkIdentifiers
+///
+/// \b Online \b examples: \n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 
 #pragma once
 

diff --git a/core/vtk/ttkMorseSmaleComplex/ttkMorseSmaleComplex.h b/core/vtk/ttkMorseSmaleComplex/ttkMorseSmaleComplex.h
@@ -100,7 +100,7 @@
 /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 /// Puzzle example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky</a>\n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/tribute/">Tribute

diff --git a/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h b/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h
@@ -107,7 +107,7 @@
 /// href="https://topology-tool-kit.github.io/examples/interactionSites/">
 /// Interaction sites</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions//">Karhunen-Love
+/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions/">Karhunen-Love
 /// Digits 64-Dimensions example</a> \n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/morsePersistence/">Morse
@@ -143,13 +143,13 @@
 /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 /// Puzzle example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological
 /// Optimization for Torus Repair example</a>\n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/tribute/">Tribute

diff --git a/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h b/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h
@@ -35,7 +35,7 @@
 /// href="https://topology-tool-kit.github.io/examples/persistentGenerators_skull/">Persistent
 /// Generators Skull example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 ///
 

diff --git a/core/vtk/ttkPointDataSelector/ttkPointDataSelector.h b/core/vtk/ttkPointDataSelector/ttkPointDataSelector.h
@@ -13,6 +13,12 @@
 ///
 /// See the related ParaView example state files for usage examples within a
 /// VTK pipeline.
+///
+/// \b Online \b examples:\n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+
 #pragma once
 
 #include <array>

diff --git a/core/vtk/ttkScalarFieldCriticalPoints/ttkScalarFieldCriticalPoints.h b/core/vtk/ttkScalarFieldCriticalPoints/ttkScalarFieldCriticalPoints.h
@@ -66,6 +66,9 @@
 /// href="https://topology-tool-kit.github.io/examples/interactionSites/">
 /// Interaction sites</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/uncertainStartingVortex/">
 /// Uncertain Starting Vortex example</a> \n
 ///

diff --git a/core/vtk/ttkScalarFieldNormalizer/ttkScalarFieldNormalizer.h b/core/vtk/ttkScalarFieldNormalizer/ttkScalarFieldNormalizer.h
@@ -39,6 +39,9 @@
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/morseSmaleQuadrangulation/">Morse-Smale
 /// Quadrangulation example</a> \n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 ///
 
 #pragma once

diff --git a/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h b/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h
@@ -47,13 +47,16 @@
 /// href="https://topology-tool-kit.github.io/examples/morsePersistence/">Morse
 /// Persistence example</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/persistentGenerators_darkSky/">Persistent
 /// Generators Dark Sky example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 
 #pragma once

diff --git a/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h b/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h
@@ -28,10 +28,10 @@
 ///
 /// \b Online \b examples: \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological
 /// Optimization for Torus Repair example</a>\n
 
 #pragma once

diff --git a/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h b/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h
@@ -116,13 +116,13 @@
 /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 /// Puzzle example</a> \n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological
 /// Optimization DarkSky example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological
 /// Optimization for Pegasus Genus Repair example</a>\n
 /// - <a
-/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological
 /// Optimization for Torus Repair example</a>\n
 /// - <a
 /// href="https://topology-tool-kit.github.io/examples/tribute/">Tribute

diff --git a/paraview/xmls/ArrayPreconditioning.xml b/paraview/xmls/ArrayPreconditioning.xml
@@ -10,6 +10,10 @@
  short_help="Array Preconditioning">
  This filter preconditions a vtkDataSet by computing an input
  order array for every selected scalar arrays.
+
+ Online examples:
+
+ - https://topology-tool-kit.github.io/examples/mpiExample/
  </Documentation>
 
  <InputProperty name="Input" command="SetInputConnection">

diff --git a/paraview/xmls/GeometrySmoother.xml b/paraview/xmls/GeometrySmoother.xml
@@ -34,6 +34,8 @@
 
  - https://topology-tool-kit.github.io/examples/morseMolecule/
 
+ - https://topology-tool-kit.github.io/examples/mpiExample/
+
  - https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/
 
  https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/

diff --git a/paraview/xmls/IntegralLines.xml b/paraview/xmls/IntegralLines.xml
@@ -21,6 +21,11 @@ data a scalar field that represent the vertex identifiers of the sources in
 the input geometry (use the Identifiers plugin prior to the selection of the
 sources if necessary to create such an identifier field).
 
+ Online examples:
+
+ - https://topology-tool-kit.github.io/examples/mpiExample/
+
+
  </Documentation>
 
  <InputProperty

diff --git a/paraview/xmls/PointDataSelector.xml b/paraview/xmls/PointDataSelector.xml
@@ -13,6 +13,10 @@
  long_help="TTK fieldSelector plugin."
  short_help="TTK fieldSelector plugin.">
  TTK fieldSelector plugin documentation.
+
+ Online examples:
+
+ - https://topology-tool-kit.github.io/examples/mpiExample/
  </Documentation>
  <InputProperty
  name="Input"

diff --git a/paraview/xmls/ScalarFieldNormalizer.xml b/paraview/xmls/ScalarFieldNormalizer.xml
@@ -14,15 +14,17 @@
  short_help="TTK plugin that normalizes an input scalar field.">
  TTK plugin that normalizes an input scalar field.
 
-  Online examples:
+ Online examples:
 
-  - https://topology-tool-kit.github.io/examples/BuiltInExample1/
+ - https://topology-tool-kit.github.io/examples/BuiltInExample1/
 
-  - https://topology-tool-kit.github.io/examples/clusteringKelvinHelmholtzInstabilities/
+ - https://topology-tool-kit.github.io/examples/clusteringKelvinHelmholtzInstabilities/
 
-  - https://topology-tool-kit.github.io/examples/harmonicSkeleton/
+ - https://topology-tool-kit.github.io/examples/harmonicSkeleton/
 
- - https://topology-tool-kit.github.io/examples/morseSmaleQuadrangulation/
+ - https://topology-tool-kit.github.io/examples/morseSmaleQuadrangulation/
+
+ - https://topology-tool-kit.github.io/examples/mpiExample/
 
  </Documentation>
  <InputProperty

diff --git a/paraview/xmls/ScalarFieldSmoother.xml b/paraview/xmls/ScalarFieldSmoother.xml
@@ -21,6 +21,8 @@
 
  - https://topology-tool-kit.github.io/examples/morsePersistence/ 
 
+ - https://topology-tool-kit.github.io/examples/mpiExample/
+
  - https://topology-tool-kit.github.io/examples/persistentGenerators_darkSky/
 
  - https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/