Skip to content

Commit 385c0de

Browse files
authored
Cleanup index page (pgRouting#2703)
Cleaning index page
1 parent ff2bbab commit 385c0de

File tree

159 files changed

+585
-405
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

159 files changed

+585
-405
lines changed

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Changes on the documentation to the following:
287287
**Issue fixes**
288288

289289
* [#2565](https://github.com/pgRouting/pgrouting/issues/2565)
290-
pgr_pgr_lengauerTarjanDominatorTree triggers an assertion
290+
pgr_lengauerTarjanDominatorTree triggers an assertion
291291

292292
**SQL enhancements**
293293

configuration.conf

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ trsp | Y | Y | Y
2626
max_flow | Y | Y | Y
2727
contraction | Y | Y | Y
2828
pickDeliver | Y | Y | Y
29-
vrp_basic | N | Y | Y
29+
vrp_basic | N | Y | N
3030
withPoints | Y | Y | Y
3131
lineGraph | Y | Y | Y
3232
components | Y | Y | Y
@@ -37,16 +37,18 @@ chinese | Y | Y | Y
3737
spanningTree | Y | Y | Y
3838
mincut | Y | Y | Y
3939
version | Y | Y | Y
40-
topologicalSort | Y | Y | Y
40+
topologicalSort | Y | Y | N
4141
transitiveClosure | Y | Y | Y
42-
breadthFirstSearch | Y | Y | Y
42+
breadthFirstSearch | Y | Y | N
4343
traversal | Y | Y | Y
4444
coloring | Y | Y | Y
4545
planar | Y | Y | Y
4646
dominator | Y | Y | Y
4747
ordering | Y | Y | Y
4848
circuits | Y | Y | Y
4949
metrics | Y | Y | Y
50+
categories | N | N | Y
51+
5052
#----------------------
5153
# SQL only directories
5254
#----------------------

doc/CMakeLists.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,9 @@ message(STATUS "PGR_DOCUMENTATION_BUILD_DIR = ${PGR_DOCUMENTATION_BUILD_DIR}")
215215
#---------------------------------------------
216216
foreach (subdir ${PROJECT_DOC_DIRECTORIES} "src")
217217
add_subdirectory("${subdir}")
218-
add_subdirectory("../docqueries/${subdir}" "build/doc/${subdir}")
218+
if (EXISTS "../docqueries/${subdir}")
219+
add_subdirectory("../docqueries/${subdir}" "build/doc/${subdir}")
220+
endif()
219221
endforeach()
220222

221223
add_subdirectory("images")

doc/allpairs/allpairs-family.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
|
1111
1212

13+
.. index:: All Pairs Family
1314

1415
All Pairs - Family of Functions
1516
===============================================================================

doc/allpairs/pgr_floydWarshall.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
|
1111
12+
.. index::
13+
single: All Pairs Family ; pgr_floydWarshall
14+
single: floydWarshall
1215

1316
``pgr_floydWarshall``
1417
===============================================================================

doc/allpairs/pgr_johnson.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
|
1111
12+
.. index::
13+
single: All Pairs Family ; pgr_johnson
14+
single: johnson
1215

1316
``pgr_johnson``
1417
===============================================================================

doc/alpha_shape/pgr_alphaShape.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
|
1111
1212

13+
.. index::
14+
single: alphaShape
15+
1316
``pgr_alphaShape``
1417
===============================================================================
1518

@@ -61,9 +64,6 @@ Signatures
6164
-------------------------------------------------------------------------------
6265
.. rubric:: Summary
6366

64-
.. index::
65-
single: alphaShape
66-
6767
.. admonition:: \ \
6868
:class: signatures
6969

doc/astar/aStar-family.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
|
1111
12+
.. index:: single: aStar Family
1213

1314
A* - Family of functions
1415
===============================================================================

doc/astar/pgr_aStar.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
|
1111
12+
.. index::
13+
single: aStar Family ; pgr_aStar
14+
single: aStar
1215

1316
``pgr_aStar``
1417
===============================================================================
@@ -96,7 +99,7 @@ Signatures
9699
Optional parameters are `named parameters` and have a default value.
97100

98101
.. index::
99-
single: aStar(One to One)
102+
single: aStar ; One to One
100103

101104
One to One
102105
...............................................................................
@@ -118,7 +121,7 @@ One to One
118121
:end-before: -- q3
119122

120123
.. index::
121-
single: astar(One to Many)
124+
single: aStar ; One to Many
122125

123126
One to Many
124127
...............................................................................
@@ -140,7 +143,7 @@ One to Many
140143
:end-before: -- q4
141144

142145
.. index::
143-
single: aStar(Many to One)
146+
single: aStar ; Many to One
144147

145148
Many to One
146149
...............................................................................
@@ -162,7 +165,7 @@ Many to One
162165
:end-before: -- q5
163166

164167
.. index::
165-
single: aStar(Many to Many)
168+
single: aStar ; Many to Many
166169

167170
Many to Many
168171
...............................................................................
@@ -184,7 +187,7 @@ Many to Many
184187
:end-before: -- q51
185188

186189
.. index::
187-
single: aStarCost(Combinations) - Proposed on v3.2
190+
single: aStar ; Combinations - Proposed on v3.2
188191

189192
Combinations
190193
...............................................................................

doc/astar/pgr_aStarCost.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
|
1111
1212

13+
.. index::
14+
single: aStar Family ; pgr_aStarCost
15+
single: aStarCost
16+
1317
pgr_aStarCost
1418
===============================================================================
1519

@@ -82,7 +86,7 @@ Signatures
8286
| OR EMPTY SET
8387
8488
.. index::
85-
single: aStarCost(One to One)
89+
single: aStarCost ; One to One
8690

8791
One to One
8892
...............................................................................
@@ -104,7 +108,7 @@ One to One
104108
:end-before: -- q3
105109

106110
.. index::
107-
single: aStarCost(One to Many)
111+
single: aStarCost ; One to Many
108112

109113
One to Many
110114
...............................................................................
@@ -126,7 +130,7 @@ One to Many
126130
:end-before: -- q4
127131

128132
.. index::
129-
single: aStarCost(Many to One)
133+
single: aStarCost ; Many to One
130134

131135
Many to One
132136
...............................................................................
@@ -148,7 +152,7 @@ Many to One
148152
:end-before: -- q5
149153

150154
.. index::
151-
single: aStarCost(Many to Many)
155+
single: aStarCost ; Many to Many
152156

153157
Many to Many
154158
...............................................................................
@@ -170,7 +174,7 @@ Many to Many
170174
:end-before: -- q51
171175

172176
.. index::
173-
single: aStarCost(Combinations) - Proposed on v3.2
177+
single: aStarCost ; Combinations - Proposed on v3.2
174178

175179
Combinations
176180
...............................................................................

0 commit comments

Comments
 (0)