Cleanup index page (#2703)

Cleaning index page
pgRouting · Dec 23, 2024 · 385c0de · 385c0de
1 parent ff2bbab
commit 385c0de
Show file tree

Hide file tree

Showing 159 changed files with 585 additions and 405 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -287,7 +287,7 @@ Changes on the documentation to the following:
 **Issue fixes**
 
 * [#2565](https://github.com/pgRouting/pgrouting/issues/2565)
-  pgr_pgr_lengauerTarjanDominatorTree triggers an assertion
+  pgr_lengauerTarjanDominatorTree triggers an assertion
 
 **SQL enhancements**
 

diff --git a/configuration.conf b/configuration.conf
@@ -26,7 +26,7 @@ trsp                | Y | Y | Y
 max_flow            | Y | Y | Y
 contraction         | Y | Y | Y
 pickDeliver         | Y | Y | Y
-vrp_basic           | N | Y | Y
+vrp_basic           | N | Y | N
 withPoints          | Y | Y | Y
 lineGraph           | Y | Y | Y
 components          | Y | Y | Y
@@ -37,16 +37,18 @@ chinese             | Y | Y | Y
 spanningTree        | Y | Y | Y
 mincut              | Y | Y | Y
 version             | Y | Y | Y
-topologicalSort     | Y | Y | Y
+topologicalSort     | Y | Y | N
 transitiveClosure   | Y | Y | Y
-breadthFirstSearch  | Y | Y | Y
+breadthFirstSearch  | Y | Y | N
 traversal           | Y | Y | Y
 coloring            | Y | Y | Y
 planar              | Y | Y | Y
 dominator           | Y | Y | Y
 ordering            | Y | Y | Y
 circuits            | Y | Y | Y
 metrics             | Y | Y | Y
+categories          | N | N | Y
+
 #----------------------
 # SQL only directories
 #----------------------

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -215,7 +215,9 @@ message(STATUS "PGR_DOCUMENTATION_BUILD_DIR = ${PGR_DOCUMENTATION_BUILD_DIR}")
 #---------------------------------------------
 foreach (subdir ${PROJECT_DOC_DIRECTORIES} "src")
     add_subdirectory("${subdir}")
-    add_subdirectory("../docqueries/${subdir}" "build/doc/${subdir}")
+    if (EXISTS "../docqueries/${subdir}")
+        add_subdirectory("../docqueries/${subdir}" "build/doc/${subdir}")
+    endif()
 endforeach()
 
 add_subdirectory("images")

diff --git a/doc/allpairs/allpairs-family.rst b/doc/allpairs/allpairs-family.rst
@@ -10,6 +10,7 @@
 |
 
 
+.. index:: All Pairs Family
 
 All Pairs - Family of Functions
 ===============================================================================

diff --git a/doc/allpairs/pgr_floydWarshall.rst b/doc/allpairs/pgr_floydWarshall.rst
@@ -9,6 +9,9 @@
 
 |
 
+.. index::
+   single: All Pairs Family ; pgr_floydWarshall
+   single: floydWarshall
 
 ``pgr_floydWarshall``
 ===============================================================================

diff --git a/doc/allpairs/pgr_johnson.rst b/doc/allpairs/pgr_johnson.rst
@@ -9,6 +9,9 @@
 
 |
 
+.. index::
+   single: All Pairs Family ; pgr_johnson
+   single: johnson
 
 ``pgr_johnson``
 ===============================================================================

diff --git a/doc/alpha_shape/pgr_alphaShape.rst b/doc/alpha_shape/pgr_alphaShape.rst
@@ -10,6 +10,9 @@
 |
 
 
+.. index::
+    single: alphaShape
+
 ``pgr_alphaShape``
 ===============================================================================
 
@@ -61,9 +64,6 @@ Signatures
 -------------------------------------------------------------------------------
 .. rubric:: Summary
 
-.. index::
-    single: alphaShape
-
 .. admonition:: \ \
    :class: signatures
 

diff --git a/doc/astar/aStar-family.rst b/doc/astar/aStar-family.rst
@@ -9,6 +9,7 @@
 
 |
 
+.. index:: single: aStar Family
 
 A* - Family of functions
 ===============================================================================

diff --git a/doc/astar/pgr_aStar.rst b/doc/astar/pgr_aStar.rst
@@ -9,6 +9,9 @@
 
 |
 
+.. index::
+   single: aStar Family ; pgr_aStar
+   single: aStar
 
 ``pgr_aStar``
 ===============================================================================
@@ -96,7 +99,7 @@ Signatures
 Optional parameters are `named parameters` and have a default value.
 
 .. index::
-    single: aStar(One to One)
+    single: aStar ; One to One
 
 One to One
 ...............................................................................
@@ -118,7 +121,7 @@ One to One
    :end-before: -- q3
 
 .. index::
-    single: astar(One to Many)
+    single: aStar ; One to Many
 
 One to Many
 ...............................................................................
@@ -140,7 +143,7 @@ One to Many
    :end-before: -- q4
 
 .. index::
-    single: aStar(Many to One)
+    single: aStar ; Many to One
 
 Many to One
 ...............................................................................
@@ -162,7 +165,7 @@ Many to One
    :end-before: -- q5
 
 .. index::
-    single: aStar(Many to Many)
+    single: aStar ; Many to Many
 
 Many to Many
 ...............................................................................
@@ -184,7 +187,7 @@ Many to Many
    :end-before: -- q51
 
 .. index::
-    single: aStarCost(Combinations) - Proposed on v3.2
+    single: aStar ; Combinations - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/astar/pgr_aStarCost.rst b/doc/astar/pgr_aStarCost.rst
@@ -10,6 +10,10 @@
 |
 
 
+.. index::
+   single: aStar Family ; pgr_aStarCost
+   single: aStarCost
+
 pgr_aStarCost
 ===============================================================================
 
@@ -82,7 +86,7 @@ Signatures
    | OR EMPTY SET
 
 .. index::
-    single: aStarCost(One to One)
+    single: aStarCost ; One to One
 
 One to One
 ...............................................................................
@@ -104,7 +108,7 @@ One to One
     :end-before: -- q3
 
 .. index::
-    single: aStarCost(One to Many)
+    single: aStarCost ; One to Many
 
 One to Many
 ...............................................................................
@@ -126,7 +130,7 @@ One to Many
    :end-before: -- q4
 
 .. index::
-    single: aStarCost(Many to One)
+    single: aStarCost ; Many to One
 
 Many to One
 ...............................................................................
@@ -148,7 +152,7 @@ Many to One
     :end-before: -- q5
 
 .. index::
-    single: aStarCost(Many to Many)
+    single: aStarCost ; Many to Many
 
 Many to Many
 ...............................................................................
@@ -170,7 +174,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: aStarCost(Combinations) - Proposed on v3.2
+    single: aStarCost ; Combinations - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/astar/pgr_aStarCostMatrix.rst b/doc/astar/pgr_aStarCostMatrix.rst
@@ -10,6 +10,10 @@
 |
 
 
+.. index::
+   single: aStar Family ; pgr_aStarCostMatrix
+   single: aStarCostMatrix
+
 ``pgr_aStarCostMatrix``
 ===============================================================================
 
@@ -52,9 +56,6 @@ Description
 
 * When the graph is **undirected** the cost matrix is symmetric
 
-.. index::
-    single: aStarCostMatrix
-
 Signatures
 -------------------------------------------------------------------------------
 

diff --git a/doc/bdAstar/bdAstar-family.rst b/doc/bdAstar/bdAstar-family.rst
@@ -9,6 +9,7 @@
 
 |
 
+.. index:: Bidirectional A* Family
 
 Bidirectional A* - Family of functions
 ===============================================================================

diff --git a/doc/bdAstar/pgr_bdAstar.rst b/doc/bdAstar/pgr_bdAstar.rst
@@ -9,6 +9,9 @@
 
 |
 
+.. index::
+   single: Bidirectional A* Family ; pgr_bdAstar
+   single: bdAstar
 
 ``pgr_bdAstar``
 ===============================================================================
@@ -94,7 +97,7 @@ Signatures
 Optional parameters are `named parameters` and have a default value.
 
 .. index::
-    single: bdAstar(One to One)
+    single: bdAstar ; One to One
 
 One to One
 ...............................................................................
@@ -116,7 +119,7 @@ One to One
    :end-before: -- q3
 
 .. index::
-    single: bdAstar(One to Many)
+    single: bdAstar ; One to Many
 
 One to Many
 ...............................................................................
@@ -138,7 +141,7 @@ One to Many
    :end-before: -- q4
 
 .. index::
-    single: bdAstar(Many to One)
+    single: bdAstar ; Many to One
 
 Many to One
 ...............................................................................
@@ -160,7 +163,7 @@ Many to One
    :end-before: -- q5
 
 .. index::
-    single: bdAstar(Many to Many)
+    single: bdAstar ; Many to Many
 
 Many to Many
 ...............................................................................
@@ -182,7 +185,7 @@ Many to Many
    :end-before: -- q51
 
 .. index::
-    single: bdAstar(Combinations) - Proposed on v3.2
+    single: bdAstar ; Combinations - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdAstar/pgr_bdAstarCost.rst b/doc/bdAstar/pgr_bdAstarCost.rst
@@ -9,6 +9,9 @@
 
 |
 
+.. index::
+   single: Bidirectional A* Family ; pgr_bdAstarCost
+   single: bdAstarCost
 
 pgr_bdAstarCost
 ===============================================================================
@@ -83,7 +86,7 @@ Signatures
    | OR EMPTY SET
 
 .. index::
-    single: bdAstarCost(One to One)
+    single: bdAstarCost ; One to One
 
 One to One
 ...............................................................................
@@ -105,7 +108,7 @@ One to One
     :end-before: -- q3
 
 .. index::
-    single: bdAstarCost(One to Many)
+    single: bdAstarCost ; One to Many
 
 One to Many
 ...............................................................................
@@ -127,7 +130,7 @@ One to Many
    :end-before: -- q4
 
 .. index::
-    single: bdAstarCost(Many to One)
+    single: bdAstarCost ; Many to One
 
 Many to One
 ...............................................................................
@@ -149,7 +152,7 @@ Many to One
     :end-before: -- q5
 
 .. index::
-    single: bdAstarCost(Many to Many)
+    single: bdAstarCost ; Many to Many
 
 Many to Many
 ...............................................................................
@@ -171,7 +174,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: bdAstarCost(Combinations) - Proposed on v3.2
+    single: bdAstarCost ; Combinations - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdAstar/pgr_bdAstarCostMatrix.rst b/doc/bdAstar/pgr_bdAstarCostMatrix.rst
@@ -9,6 +9,9 @@
 
 |
 
+.. index::
+   single: Bidirectional A* Family ; pgr_bdAstarCostMatrix
+   single: bdAstarCostMatrix
 
 ``pgr_bdAstarCostMatrix``
 ===============================================================================
@@ -52,9 +55,6 @@ Description
 
 * When the graph is **undirected** the cost matrix is symmetric
 
-.. index::
-    single: bdAstarCostMatrix
-
 Signatures
 -------------------------------------------------------------------------------
 

diff --git a/doc/bdDijkstra/bdDijkstra-family.rst b/doc/bdDijkstra/bdDijkstra-family.rst
@@ -9,8 +9,8 @@
 
 |
 
-.. rubric:: Previous versions of this page
 
+.. index:: Bidirectional Dijkstra Family
 
 Bidirectional Dijkstra - Family of functions
 ===============================================================================
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ @@
     |
+    .. index:: All Pairs Family
     All Pairs - Family of Functions
     ===============================================================================
@@ Expand Down @@