Skip to content

Commit 4429be2

Browse files
github-actions[bot]github-actions[bot]
committed
Update users documentation for 4.0.0 for develop branch: commit 6599bd6 
1 parent 5cc4e5c commit 4429be2

925 files changed

Lines changed: 8988 additions & 26747 deletions

File tree

Some content is hidden

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

‎4.0/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: 38c4824f5ac133bdb8232d52e74d76bb
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: a273d6d07565b1a98d23b046798e906c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎4.0/en/BFS-category.html‎

Lines changed: 6 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

1010
<title>BFS - Category &#8212; pgRouting Manual (4.0-dev)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
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" />
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
1514
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
1615
<script src="_static/documentation_options.js?v=798e95cd"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1918
<script src="_static/page_history.js?v=a458cb6c"></script>
2019
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -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_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>
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">
@@ -438,8 +403,8 @@ <h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading">
438403
</p>
439404
<p>
440405
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
441-
Last updated on Jul 04, 2025.<br/>
442-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
406+
Last updated on Jul 28, 2025.<br/>
407+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
443408
</p>
444409
</div>
445410
</footer>

‎4.0/en/DFS-category.html‎

Lines changed: 11 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

1010
<title>DFS - Category &#8212; pgRouting Manual (4.0-dev)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
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" />
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
1514
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
1615
<script src="_static/documentation_options.js?v=798e95cd"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1918
<script src="_static/page_history.js?v=a458cb6c"></script>
2019
<link rel="icon" href="_static/favicon.ico"/>
@@ -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="d8ff19de-4bfc-48f2-9520-017cca4e40c1" name="d8ff19de-4bfc-48f2-9520-017cca4e40c1" type="checkbox"><label class="sphinx_collapse__label" for="d8ff19de-4bfc-48f2-9520-017cca4e40c1"><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>
@@ -249,8 +219,8 @@ <h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading">
249219
</p>
250220
<p>
251221
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
252-
Last updated on Jul 04, 2025.<br/>
253-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
222+
Last updated on Jul 28, 2025.<br/>
223+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
254224
</p>
255225
</div>
256226
</footer>

‎4.0/en/KSP-category.html‎

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

1010
<title>K shortest paths - Category &#8212; pgRouting Manual (4.0-dev)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
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" />
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
1514
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
1615
<script src="_static/documentation_options.js?v=798e95cd"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1918
<script src="_static/page_history.js?v=a458cb6c"></script>
2019
<link rel="icon" href="_static/favicon.ico"/>
@@ -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="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>
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">
@@ -193,8 +170,8 @@ <h1>K shortest paths - Category<a class="headerlink" href="#k-shortest-paths-cat
193170
</p>
194171
<p>
195172
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
196-
Last updated on Jul 04, 2025.<br/>
197-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
173+
Last updated on Jul 28, 2025.<br/>
174+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
198175
</p>
199176
</div>
200177
</footer>

‎4.0/en/TRSP-family.html‎

Lines changed: 10 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
99

1010
<title>TRSP - Family of functions &#8212; pgRouting Manual (4.0-dev)</title>
11-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
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" />
13+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
1514
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4a28828c" />
1615
<script src="_static/documentation_options.js?v=798e95cd"></script>
17-
<script src="_static/doctools.js?v=9bcbadda"></script>
16+
<script src="_static/doctools.js?v=888ff710"></script>
1817
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1918
<script src="_static/page_history.js?v=a458cb6c"></script>
2019
<link rel="icon" href="_static/favicon.ico"/>
@@ -152,42 +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="#">TRSP - Family of functions</a><ul>
158-
<li><a class="reference internal" href="#introduction">Introduction</a><ul>
159-
<li><a class="reference internal" href="#trsp-algorithm">TRSP algorithm</a></li>
160-
<li><a class="reference internal" href="#parameters">Parameters</a></li>
161-
<li><a class="reference internal" href="#restrictions">Restrictions</a></li>
162-
<li><a class="reference internal" href="#edges-sql">Edges SQL</a><ul>
163-
<li><a class="reference internal" href="#restrictions-sql">Restrictions SQL</a></li>
164-
</ul>
165-
</li>
166-
</ul>
167-
</li>
168-
<li><a class="reference internal" href="#see-also">See Also</a></li>
169-
</ul>
170-
</li>
171-
</ul>
172-
173-
<li>
174-
<a href="pgr_full_version.html" title="Previous Chapter: pgr_full_version"><span class="icon-chevron-left visible-tablet"></span><span class="hidden-sm hidden-tablet">&laquo; pgr_full_version</span>
175-
</a>
176-
</li>
177-
<li>
178-
<a href="pgr_trsp.html" title="Next Chapter: pgr_trsp"><span class="icon-chevron-right visible-tablet"></span><span class="hidden-sm hidden-tablet">pgr_trsp &raquo;</span>
179-
</a>
180-
</li>
181-
<form action="search.html" method="get">
182-
<div class="form-group">
183-
<input type="text" name="q" class="form-control" placeholder="Search" />
184-
</div>
185-
<input type="hidden" name="check_keywords" value="yes" />
186-
<input type="hidden" name="area" value="default" />
187-
</form>
188-
</div>
189-
</div>
190-
<div class="body span9 content" role="main">
154+
<div class="body span12 content" role="main">
191155
<script> document.write(get_history('TRSP-family','en')); </script>
192156

193157
<div class="line-block" id="index-0">
@@ -202,15 +166,8 @@ <h1>TRSP - Family of functions<a class="headerlink" href="#trsp-family-of-functi
202166
<li><p><a class="reference internal" href="pgr_trsp_withPoints.html"><span class="doc">pgr_trsp_withPoints</span></a> - Vertex/Point routing with restrictions.</p></li>
203167
<li><p><a class="reference internal" href="pgr_trspVia_withPoints.html"><span class="doc">pgr_trspVia_withPoints</span></a> - Via Vertex/point routing with restrictions.</p></li>
204168
</ul>
205-
<div class="sphinx_collapse docutils container">
206-
<input class="sphinx_collapse__input" id="627dfe66-baba-4a8b-85de-08344d64f344" name="627dfe66-baba-4a8b-85de-08344d64f344" type="checkbox"><label class="sphinx_collapse__label" for="627dfe66-baba-4a8b-85de-08344d64f344"><i class="sphinx_collapse__icon"></i>Experimental</label><div class="sphinx_collapse__content docutils container">
207-
<div class="admonition warning">
208-
<p class="admonition-title">Warning</p>
209-
<p>Possible server crash</p>
210-
<ul class="simple">
211-
<li><p>These functions might create a server crash</p></li>
212-
</ul>
213-
</div>
169+
<div class="admonition-experimental admonition">
170+
<p class="admonition-title">Experimental</p>
214171
<div class="admonition warning">
215172
<p class="admonition-title">Warning</p>
216173
<p>Experimental functions</p>
@@ -223,19 +180,14 @@ <h1>TRSP - Family of functions<a class="headerlink" href="#trsp-family-of-functi
223180
<li><p>Signature might change.</p></li>
224181
<li><p>Functionality might change.</p></li>
225182
<li><p>pgTap tests might be missing.</p></li>
226-
<li><p>Might need c/c++ coding.</p></li>
227-
<li><p>May lack documentation.</p></li>
183+
<li><p>Might need c/c++ review.</p></li>
228184
<li><p>Documentation if any might need to be rewritten.</p></li>
229-
<li><p>Documentation examples might need to be automatically generated.</p></li>
230185
<li><p>Might need a lot of feedback from the community.</p></li>
231-
<li><p>Might depend on a proposed function of pgRouting</p></li>
232-
<li><p>Might depend on a deprecated function of pgRouting</p></li>
233186
</ul>
234187
</li>
235188
</ul>
236189
</div>
237190
</div>
238-
</div>
239191
<ul class="simple">
240192
<li><p><a class="reference internal" href="pgr_turnRestrictedPath.html"><span class="doc">pgr_turnRestrictedPath - Experimental</span></a> - Routing with restrictions.</p></li>
241193
</ul>
@@ -299,8 +251,7 @@ <h3>Restrictions<a class="headerlink" href="#restrictions" title="Link to this h
299251
<p>A restriction is a sequence of edges, called path and that path is to be
300252
avoided.</p>
301253
<figure class="align-default" id="id1">
302-
<a class="reference internal image-reference" href="_images/with_restrictions.png"><img alt="_images/with_restrictions.png" src="_images/with_restrictions.png" style="width: 475.5px; height: 433.0px;" />
303-
</a>
254+
<a class="reference internal image-reference" href="_images/with_restrictions.png"><img alt="_images/with_restrictions.png" src="_images/with_restrictions.png" style="width: 475.5px; height: 433.0px;" /></a>
304255
<figcaption>
305256
<p><span class="caption-text"><strong>Restrictions on the road network</strong></span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
306257
</figcaption>
@@ -452,8 +403,8 @@ <h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading">
452403
</p>
453404
<p>
454405
&copy; Copyright pgRouting Contributors - Version v4.0.<br/>
455-
Last updated on Jul 04, 2025.<br/>
456-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.3.<br/>
406+
Last updated on Jul 28, 2025.<br/>
407+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
457408
</p>
458409
</div>
459410
</footer>

0 commit comments

Comments
 (0)