Skip to content

Commit 960da71

Browse files
Update users documentation for 4.0.0 for main branch: commit 91929d9
1 parent 6cc6127 commit 960da71

File tree

1,346 files changed

+148307
-60029
lines changed

Some content is hidden

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

1,346 files changed

+148307
-60029
lines changed

main/en/.buildinfo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: d144a5e5c115b00ca08abac11cb0fa9d
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: a87ad46cf579cd62be2a72861abc4b7e
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

main/en/BFS-category.html

Lines changed: 14 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,21 @@
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

10-
<title>BFS - Category &#8212; pgRouting Manual (3.8)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
10+
<title>BFS - Category &#8212; pgRouting Manual (4.0-alpha1)</title>
11+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1212
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=5a695559" />
13-
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
14-
<link rel="stylesheet" type="text/css" href="_static/sphinx_collapse.css?v=226d88b4" />
15-
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=e38b2961" />
16-
<script src="_static/documentation_options.js?v=79c17324"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
14+
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
15+
<script src="_static/documentation_options.js?v=27c7622d"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19-
<script src="_static/page_history.js?v=262773b0"></script>
18+
<script src="_static/page_history.js?v=ee02e9fc"></script>
2019
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
2120
<link rel="icon" href="_static/favicon.ico"/>
2221
<link rel="index" title="Index" href="genindex.html" />
2322
<link rel="search" title="Search" href="search.html" />
2423
<link rel="next" title="Cost - Category" href="cost-category.html" />
25-
<link rel="prev" title="pgr_TSPeuclidean" href="pgr_TSPeuclidean.html" />
24+
<link rel="prev" title="pgr_withPointsVia" href="pgr_withPointsVia.html" />
2625
<meta charset='utf-8'>
2726
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
2827
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
@@ -46,7 +45,7 @@
4645

4746
<a class="brand" href="index.html">
4847
pgRouting</a>
49-
<span class="navbar-text pull-left"><b>v3.8</b></span>
48+
<span class="navbar-text pull-left"><b>v4.0</b></span>
5049

5150
<div class="nav-collapse">
5251
<ul class="nav">
@@ -119,7 +118,7 @@
119118

120119

121120
<li>
122-
<a href="pgr_TSPeuclidean.html" title="Previous Chapter: pgr_TSPeuclidean"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; pgr_TSPeuclidean</span>
121+
<a href="pgr_withPointsVia.html" title="Previous Chapter: pgr_withPointsVia"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; pgr_withPointsVia</span>
123122
</a>
124123
</li>
125124
<li>
@@ -152,41 +151,7 @@
152151

153152
<div class="container">
154153
<div class="row">
155-
<div class="span3">
156-
<div id="sidebar" class="bs-sidenav well" data-spy="affix"><ul>
157-
<li><a class="reference internal" href="#">BFS - Category</a><ul>
158-
<li><a class="reference internal" href="#parameters">Parameters</a><ul>
159-
<li><a class="reference internal" href="#bfs-optional-parameters">BFS optional parameters</a></li>
160-
</ul>
161-
</li>
162-
<li><a class="reference internal" href="#inner-queries">Inner Queries</a><ul>
163-
<li><a class="reference internal" href="#edges-sql">Edges SQL</a></li>
164-
</ul>
165-
</li>
166-
<li><a class="reference internal" href="#result-columns">Result columns</a></li>
167-
<li><a class="reference internal" href="#see-also">See Also</a></li>
168-
</ul>
169-
</li>
170-
</ul>
171-
172-
<li>
173-
<a href="pgr_TSPeuclidean.html" title="Previous Chapter: pgr_TSPeuclidean"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; pgr_TSPeuclidean</span>
174-
</a>
175-
</li>
176-
<li>
177-
<a href="cost-category.html" title="Next Chapter: Cost - Category"><span class="icon-chevron-right visible-tablet"></span><span class="hidden-sm hidden-tablet">Cost - Category &raquo;</span>
178-
</a>
179-
</li>
180-
<form action="search.html" method="get">
181-
<div class="form-group">
182-
<input type="text" name="q" class="form-control" placeholder="Search" />
183-
</div>
184-
<input type="hidden" name="check_keywords" value="yes" />
185-
<input type="hidden" name="area" value="default" />
186-
</form>
187-
</div>
188-
</div>
189-
<div class="body span9 content" role="main">
154+
<div class="body span12 content" role="main">
190155
<script> document.write(get_history('BFS-category','en')); </script>
191156

192157
<div class="line-block" id="index-0">
@@ -437,9 +402,9 @@ <h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading">
437402

438403
</p>
439404
<p>
440-
&copy; Copyright pgRouting Contributors - Version v3.8.<br/>
441-
Last updated on Sep 13, 2025.<br/>
442-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
405+
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
406+
Last updated on Sep 19, 2025.<br/>
407+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
443408
</p>
444409
</div>
445410
</footer>

main/en/DFS-category.html

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,15 @@
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

10-
<title>DFS - Category &#8212; pgRouting Manual (3.8)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
10+
<title>DFS - Category &#8212; pgRouting Manual (4.0-alpha1)</title>
11+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1212
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=5a695559" />
13-
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
14-
<link rel="stylesheet" type="text/css" href="_static/sphinx_collapse.css?v=226d88b4" />
15-
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=e38b2961" />
16-
<script src="_static/documentation_options.js?v=79c17324"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
14+
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
15+
<script src="_static/documentation_options.js?v=27c7622d"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19-
<script src="_static/page_history.js?v=262773b0"></script>
18+
<script src="_static/page_history.js?v=ee02e9fc"></script>
2019
<link rel="icon" href="_static/favicon.ico"/>
2120
<link rel="index" title="Index" href="genindex.html" />
2221
<link rel="search" title="Search" href="search.html" />
@@ -45,7 +44,7 @@
4544

4645
<a class="brand" href="index.html">
4746
pgRouting</a>
48-
<span class="navbar-text pull-left"><b>v3.8</b></span>
47+
<span class="navbar-text pull-left"><b>v4.0</b></span>
4948

5049
<div class="nav-collapse">
5150
<ul class="nav">
@@ -142,32 +141,7 @@
142141

143142
<div class="container">
144143
<div class="row">
145-
<div class="span3">
146-
<div id="sidebar" class="bs-sidenav well" data-spy="affix"><ul>
147-
<li><a class="reference internal" href="#">DFS - Category</a><ul>
148-
<li><a class="reference internal" href="#see-also">See Also</a></li>
149-
</ul>
150-
</li>
151-
</ul>
152-
153-
<li>
154-
<a href="costMatrix-category.html" title="Previous Chapter: Cost Matrix - Category"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; Cost Matrix -...</span>
155-
</a>
156-
</li>
157-
<li>
158-
<a href="drivingDistance-category.html" title="Next Chapter: Driving Distance - Category"><span class="icon-chevron-right visible-tablet"></span><span class="hidden-sm hidden-tablet">Driving Dista... &raquo;</span>
159-
</a>
160-
</li>
161-
<form action="search.html" method="get">
162-
<div class="form-group">
163-
<input type="text" name="q" class="form-control" placeholder="Search" />
164-
</div>
165-
<input type="hidden" name="check_keywords" value="yes" />
166-
<input type="hidden" name="area" value="default" />
167-
</form>
168-
</div>
169-
</div>
170-
<div class="body span9 content" role="main">
144+
<div class="body span12 content" role="main">
171145
<script> document.write(get_history('DFS-category','en')); </script>
172146

173147
<div class="line-block" id="index-0">
@@ -180,27 +154,23 @@ <h1>DFS - Category<a class="headerlink" href="#dfs-category" title="Link to this
180154
<li><p><a class="reference internal" href="pgr_kruskalDFS.html"><span class="doc">pgr_kruskalDFS</span></a></p></li>
181155
<li><p><a class="reference internal" href="pgr_primDFS.html"><span class="doc">pgr_primDFS</span></a></p></li>
182156
</ul>
183-
<div class="sphinx_collapse docutils container">
184-
<input class="sphinx_collapse__input" id="be0b2bdc-0697-4b99-ace5-19e99a2b6034" name="be0b2bdc-0697-4b99-ace5-19e99a2b6034" type="checkbox"><label class="sphinx_collapse__label" for="be0b2bdc-0697-4b99-ace5-19e99a2b6034"><i class="sphinx_collapse__icon"></i>Proposed</label><div class="sphinx_collapse__content docutils container">
157+
<div class="admonition-proposed admonition">
158+
<p class="admonition-title">Proposed</p>
185159
<div class="admonition warning">
186160
<p class="admonition-title">Warning</p>
187161
<p>Proposed functions for next mayor release.</p>
188162
<ul class="simple">
189-
<li><p>They are not officially in the current release.</p></li>
190-
<li><p>They will likely officially be part of the next mayor release:</p>
163+
<li><p>They are not officially in the current release.</p>
191164
<ul>
192-
<li><p>The functions make use of ANY-INTEGER and ANY-NUMERICAL</p></li>
193-
<li><p>Name might not change. (But still can)</p></li>
194-
<li><p>Signature might not change. (But still can)</p></li>
195-
<li><p>Functionality might not change. (But still can)</p></li>
165+
<li><p>Code has been reviewed therefore is not experimental.</p></li>
166+
<li><p>Name, signature and functionality might not change.</p></li>
196167
<li><p>pgTap tests have being done. But might need more.</p></li>
197168
<li><p>Documentation might need refinement.</p></li>
198169
</ul>
199170
</li>
200171
</ul>
201172
</div>
202173
</div>
203-
</div>
204174
<ul class="simple">
205175
<li><p><a class="reference internal" href="pgr_depthFirstSearch.html"><span class="doc">pgr_depthFirstSearch - Proposed</span></a> - Depth first search traversal of the graph.</p></li>
206176
</ul>
@@ -248,9 +218,9 @@ <h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading">
248218

249219
</p>
250220
<p>
251-
&copy; Copyright pgRouting Contributors - Version v3.8.<br/>
252-
Last updated on Sep 13, 2025.<br/>
253-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
221+
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
222+
Last updated on Sep 19, 2025.<br/>
223+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
254224
</p>
255225
</div>
256226
</footer>

main/en/KSP-category.html

Lines changed: 17 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,20 @@
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

10-
<title>K shortest paths - Category &#8212; pgRouting Manual (3.8)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
10+
<title>K shortest paths - Category &#8212; pgRouting Manual (4.0-alpha1)</title>
11+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1212
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=5a695559" />
13-
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
14-
<link rel="stylesheet" type="text/css" href="_static/sphinx_collapse.css?v=226d88b4" />
15-
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=e38b2961" />
16-
<script src="_static/documentation_options.js?v=79c17324"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
14+
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
15+
<script src="_static/documentation_options.js?v=27c7622d"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19-
<script src="_static/page_history.js?v=262773b0"></script>
18+
<script src="_static/page_history.js?v=ee02e9fc"></script>
2019
<link rel="icon" href="_static/favicon.ico"/>
2120
<link rel="index" title="Index" href="genindex.html" />
2221
<link rel="search" title="Search" href="search.html" />
2322
<link rel="next" title="Spanning Tree - Category" href="spanningTree-category.html" />
24-
<link rel="prev" title="pgr_alphaShape" href="pgr_alphaShape.html" />
23+
<link rel="prev" title="Driving Distance - Category" href="drivingDistance-category.html" />
2524
<meta charset='utf-8'>
2625
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
2726
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
@@ -45,7 +44,7 @@
4544

4645
<a class="brand" href="index.html">
4746
pgRouting</a>
48-
<span class="navbar-text pull-left"><b>v3.8</b></span>
47+
<span class="navbar-text pull-left"><b>v4.0</b></span>
4948

5049
<div class="nav-collapse">
5150
<ul class="nav">
@@ -74,8 +73,8 @@
7473
<ul class="current">
7574
<li class="toctree-l1 current"><a class="reference internal" href="routingFunctions.html">Function Families</a></li>
7675
</ul>
77-
<ul class="current">
78-
<li class="toctree-l1 current"><a class="reference internal" href="proposed.html">Proposed Functions</a></li>
76+
<ul>
77+
<li class="toctree-l1"><a class="reference internal" href="proposed.html">Proposed Functions</a></li>
7978
<li class="toctree-l1"><a class="reference internal" href="experimental.html">Experimental Functions</a></li>
8079
</ul>
8180
<ul>
@@ -106,7 +105,7 @@
106105

107106

108107
<li>
109-
<a href="pgr_alphaShape.html" title="Previous Chapter: pgr_alphaShape"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; pgr_alphaShape</span>
108+
<a href="drivingDistance-category.html" title="Previous Chapter: Driving Distance - Category"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; Driving Dista...</span>
110109
</a>
111110
</li>
112111
<li>
@@ -139,29 +138,7 @@
139138

140139
<div class="container">
141140
<div class="row">
142-
<div class="span3">
143-
<div id="sidebar" class="bs-sidenav well" data-spy="affix"><ul>
144-
<li><a class="reference internal" href="#">K shortest paths - Category</a></li>
145-
</ul>
146-
147-
<li>
148-
<a href="pgr_alphaShape.html" title="Previous Chapter: pgr_alphaShape"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; pgr_alphaShape</span>
149-
</a>
150-
</li>
151-
<li>
152-
<a href="spanningTree-category.html" title="Next Chapter: Spanning Tree - Category"><span class="icon-chevron-right visible-tablet"></span><span class="hidden-sm hidden-tablet">Spanning Tree... &raquo;</span>
153-
</a>
154-
</li>
155-
<form action="search.html" method="get">
156-
<div class="form-group">
157-
<input type="text" name="q" class="form-control" placeholder="Search" />
158-
</div>
159-
<input type="hidden" name="check_keywords" value="yes" />
160-
<input type="hidden" name="area" value="default" />
161-
</form>
162-
</div>
163-
</div>
164-
<div class="body span9 content" role="main">
141+
<div class="body span12 content" role="main">
165142
<script> document.write(get_history('KSP-category','en')); </script>
166143

167144
<div class="line-block" id="index-0">
@@ -171,30 +148,7 @@
171148
<h1>K shortest paths - Category<a class="headerlink" href="#k-shortest-paths-category" title="Link to this heading"></a></h1>
172149
<ul class="simple">
173150
<li><p><a class="reference internal" href="pgr_KSP.html"><span class="doc">pgr_KSP</span></a> - Yen’s algorithm based on pgr_dijkstra</p></li>
174-
</ul>
175-
<div class="sphinx_collapse docutils container">
176-
<input class="sphinx_collapse__input" id="46b659e9-dd8f-477b-a7c6-d990222c8710" name="46b659e9-dd8f-477b-a7c6-d990222c8710" type="checkbox"><label class="sphinx_collapse__label" for="46b659e9-dd8f-477b-a7c6-d990222c8710"><i class="sphinx_collapse__icon"></i>Proposed</label><div class="sphinx_collapse__content docutils container">
177-
<div class="admonition warning">
178-
<p class="admonition-title">Warning</p>
179-
<p>Proposed functions for next mayor release.</p>
180-
<ul class="simple">
181-
<li><p>They are not officially in the current release.</p></li>
182-
<li><p>They will likely officially be part of the next mayor release:</p>
183-
<ul>
184-
<li><p>The functions make use of ANY-INTEGER and ANY-NUMERICAL</p></li>
185-
<li><p>Name might not change. (But still can)</p></li>
186-
<li><p>Signature might not change. (But still can)</p></li>
187-
<li><p>Functionality might not change. (But still can)</p></li>
188-
<li><p>pgTap tests have being done. But might need more.</p></li>
189-
<li><p>Documentation might need refinement.</p></li>
190-
</ul>
191-
</li>
192-
</ul>
193-
</div>
194-
</div>
195-
</div>
196-
<ul class="simple">
197-
<li><p><a class="reference internal" href="pgr_withPointsKSP.html"><span class="doc">pgr_withPointsKSP - Proposed</span></a> - Yen’s algorithm based on pgr_withPoints</p></li>
151+
<li><p><a class="reference internal" href="pgr_withPointsKSP.html"><span class="doc">pgr_withPointsKSP</span></a> - Yen’s algorithm based on pgr_withPoints</p></li>
198152
</ul>
199153
<p class="rubric">Indices and tables</p>
200154
<ul class="simple">
@@ -215,9 +169,9 @@ <h1>K shortest paths - Category<a class="headerlink" href="#k-shortest-paths-cat
215169

216170
</p>
217171
<p>
218-
&copy; Copyright pgRouting Contributors - Version v3.8.<br/>
219-
Last updated on Sep 13, 2025.<br/>
220-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
172+
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
173+
Last updated on Sep 19, 2025.<br/>
174+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
221175
</p>
222176
</div>
223177
</footer>

0 commit comments

Comments
 (0)