Skip to content

Commit 6320b29

Browse files
committed
[documentation] adding a table
1 parent 7d65048 commit 6320b29

File tree

5 files changed

+19
-36
lines changed

5 files changed

+19
-36
lines changed

builddoc.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/bin/bash
22
rm -fR site
33
mkdocs gh-deploy --clean
4-
rm -fR site
4+
#rm -fR site

docs/functions/pgr_astar.md

-20
This file was deleted.

docs/functions/pgr_dijkstra.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
- Uses BBOX of the QGIS canvas to limit the resulting path(s)
44

5-
- Buttons:
6-
- ![Preview](../img/buttons/execute/preview.png): Draws in the canvas the resulting path
7-
- ![Clear Preview](../img/buttons/execute/clearpreview.png): Removes from the canvas objects generated with Preview
8-
- ![Export](../img/buttons/execute/export.png): Creates a one row per edge line geometry layer
9-
- Layer name:
10-
```
11-
(< U|D >) pgr_dijkstra: < source_id > to < target_id> BBOX(< bbox >)
12-
```
13-
- ![Export Merged](../img/buttons/execute/exportmergedON.png): Creates a one row per path multiline geometry layer. As many rows as needed.
14-
- Layer name:
15-
```
16-
(M < U|D >) pgr_dijkstra: < source_id > to < target_id> BBOX(< bbox >)
17-
```
5+
## Execute tab
6+
![Execute tab](../img/tabs/execute/execute.png)
187

19-
![pgr_dijkstra1](../img/dijkstra1.png)
20-
![pgr_dijkstra1](../img/dijkstra1-1.png)
8+
|Button|Action|
9+
| ----------- | --------- |
10+
|![Preview](../img/buttons/execute/preview.png)| Draws in the canvas the resulting path |
11+
|![Clear Preview](../img/buttons/execute/clearpreview.png)| Removes from the canvas objects generated with Preview|
12+
|![Export](../img/buttons/execute/export.png)| Creates a one row per edge line geometry layer|
13+
|![Export Merged](../img/buttons/execute/exportmergedON.png)| Creates a one row per path multiline geometry layer. As many rows as needed|
14+
15+
Depending on the pressed button the layer name will be
16+
```
17+
(<U|D>) pgr_dijkstra: <source_id> to <target_id> BBOX(<bbox>)
18+
(M <U|D>) pgr_dijkstra: <source_id> to <target_id> BBOX(<bbox>)
19+
```

mkdocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ nav:
66
- Layer naming convention: intro/layer_naming_convention.md
77
- Functions:
88
- pgr_djikstra: functions/pgr_dijkstra.md
9+
- pgr_KSP: functions/pgr_KSP.md
10+
- pgr_aStar: functions/pgr_aStar.md
11+
- pgr_bdAstar: functions/pgr_bdAstar.md
12+
- pgr_bdDijkstra: functions/pgr_bdDijkstra.md
913
theme: readthedocs

0 commit comments

Comments
 (0)